diff --git a/.github/allowed-actions.js b/.github/allowed-actions.js index f36a680b343f..f79587f683cf 100644 --- a/.github/allowed-actions.js +++ b/.github/allowed-actions.js @@ -26,6 +26,7 @@ module.exports = [ "juliangruber/find-pull-request-action@2fc55e82a6d5d36fe1e7f1848f7e64fd02d99de9", "juliangruber/read-file-action@e0a316da496006ffd19142f0fd594a1783f3b512", "lee-dohm/close-matching-issues@22002609b2555fe18f52b8e2e7c07cbf5529e8a8", + "octokit/graphql-action@5b3e01d42dee4509b0ac6b1cb2cf7778cdce85c2", "pascalgn/automerge-action@c9bd1823770819dc8fb8a5db2d11a3a95fbe9b07", //pascalgn/automerge@0.12.0 "peter-evans/create-issue-from-file@a04ce672e3acedb1f8e416b46716ddfd09905326", "peter-evans/create-or-update-comment@5221bf4aa615e5c6e95bb142f9673a9c791be2cd", diff --git a/.github/commands/remove.yaml b/.github/commands/remove.yaml new file mode 100644 index 000000000000..e527282ee30f --- /dev/null +++ b/.github/commands/remove.yaml @@ -0,0 +1,10 @@ +trigger: remove-from-fr-board +title: Remove from FR board +description: Remove the current issue or pull request from the project board for the docs content first responder +surfaces: + - issue + - pull_request + - discussion +steps: + - type: repository_dispatch + eventType: remove_from_FR_board diff --git a/.github/workflows/browser-test.yml b/.github/workflows/browser-test.yml index 752c100f6e20..a27ff0faf94a 100644 --- a/.github/workflows/browser-test.yml +++ b/.github/workflows/browser-test.yml @@ -2,10 +2,10 @@ name: Browser Tests on: workflow_dispatch: - push: - branches: - - main - pull_request: + # push: + # branches: + # - main + # pull_request: jobs: see_if_should_skip: @@ -40,11 +40,13 @@ jobs: - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} name: Install uses: ianwalter/puppeteer-container@2466ba8ecf689ccf4e5dfadeff3ac2db227b2e17 + timeout-minutes: 5 with: args: npm ci - if: ${{ needs.see_if_should_skip.outputs.should_skip != 'true' }} name: Test + timeout-minutes: 10 uses: ianwalter/puppeteer-container@2466ba8ecf689ccf4e5dfadeff3ac2db227b2e17 with: args: npm run browser-test diff --git a/.github/workflows/post-status-updates-to-slack.yml b/.github/workflows/post-status-updates-to-slack.yml index 484557026c21..bec7cfb879fc 100644 --- a/.github/workflows/post-status-updates-to-slack.yml +++ b/.github/workflows/post-status-updates-to-slack.yml @@ -19,5 +19,5 @@ jobs: id: notify with: slack-channel: 'C01EEKVR0Q7' - slack-bot-user-oauth-access-token: ${{ secrets.SLACK_DOCS_BOT_TOKEN }} + slack-bot-user-oauth-access-token: ${{ secrets.SLACK_BOT_TOKEN }} slack-text: \n><${{ github.event.comment.html_url}}|*${{github.event.issue.title}}*>\nstatus update posted by ${{github.event.comment.user.login}}\n\n${{ steps.trimmed.outputs.value }} diff --git a/.github/workflows/remove-from-fr-board.yaml b/.github/workflows/remove-from-fr-board.yaml new file mode 100644 index 000000000000..03ce33d94fc1 --- /dev/null +++ b/.github/workflows/remove-from-fr-board.yaml @@ -0,0 +1,64 @@ +name: Remove card from FR board + +on: + repository_dispatch: + types: remove_from_FR_board + +jobs: + remove_from_FR_board: + if: github.repository == 'github/docs-internal' + runs-on: ubuntu-latest + steps: + - id: find_project_cards + uses: octokit/graphql-action@5b3e01d42dee4509b0ac6b1cb2cf7778cdce85c2 + with: + query: | + query($issue_node_id:ID!) { + node(id:$issue_node_id) { + ... on Issue { + projectCards(first: 10) { + nodes { + id + project { + name + id + } + } + } + } + ... on PullRequest { + projectCards(first: 10) { + nodes { + id + project { + name + id + } + } + } + } + } + } + issue_node_id: ${{ github.event.client_payload.command.resource.id }} + env: + GITHUB_TOKEN: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} + + - run: "echo 'Project cards found: ${{ steps.find_project_cards.outputs.data }}'" + + - name: Get FR card + env: + QUERY_DATA: ${{ steps.find_project_cards.outputs.data }} + run: | + echo 'FR_CARDS='$(jq '.node.projectCards.nodes | .[] | select(.project.id == "MDc6UHJvamVjdDQ1NzI0ODI=") | .id' <<< "$QUERY_DATA") >> $GITHUB_ENV + + - name: Delete card + id: delete_project_card + if: ${{ env.FR_CARDS }} + uses: octokit/graphql-action@5b3e01d42dee4509b0ac6b1cb2cf7778cdce85c2 + with: + query: | + mutation DeleteCard { + deleteProjectCard(input:{cardId:${{ env.FR_CARDS }}}) {deletedCardId} + } + env: + GITHUB_TOKEN: ${{ secrets.DOCUBOT_FR_PROJECT_BOARD_WORKFLOWS_REPO_ORG_READ_SCOPES }} diff --git a/.github/workflows/repo-freeze-check.yml b/.github/workflows/repo-freeze-check.yml index b50ebc27547b..c9c892e2a35d 100644 --- a/.github/workflows/repo-freeze-check.yml +++ b/.github/workflows/repo-freeze-check.yml @@ -22,7 +22,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Fail if repo merges are paused - if: ${{ env.FREEZE == 'true' && github.ref != 'refs/heads/repo-sync' }} + if: ${{ env.FREEZE == 'true' && github.head_ref != 'repo-sync' }} run: | echo 'Merges into the "main" branch on this repo are currently paused!' exit 1 diff --git a/.github/workflows/triage-pull-requests.yml b/.github/workflows/triage-pull-requests.yml index f83ff5c9e8d5..abff3a84c368 100644 --- a/.github/workflows/triage-pull-requests.yml +++ b/.github/workflows/triage-pull-requests.yml @@ -7,7 +7,7 @@ on: jobs: triage_pulls: - if: github.repository == 'github/docs' + if: github.repository != 'github/docs-internal' runs-on: ubuntu-latest steps: diff --git a/.github/workflows/update-graphql-files.yml b/.github/workflows/update-graphql-files.yml index a610bf5bf880..7e61137b57b8 100644 --- a/.github/workflows/update-graphql-files.yml +++ b/.github/workflows/update-graphql-files.yml @@ -56,7 +56,7 @@ jobs: If CI does not pass or other problems arise, contact #docs-engineering on slack." labels: automerge,autoupdate branch: graphql-schema-update - - if: ${{ failure() }} + - if: ${{ failure() && env.FREEZE != 'true'}} name: Delete remote branch (if previous steps failed) uses: dawidd6/action-delete-branch@47743101a121ad657031e6704086271ca81b1911 with: diff --git a/assets/images/enterprise/configuration/ae-discard-email.png b/assets/images/enterprise/configuration/ae-discard-email.png new file mode 100644 index 000000000000..a11a3b12ce18 Binary files /dev/null and b/assets/images/enterprise/configuration/ae-discard-email.png differ diff --git a/assets/images/enterprise/configuration/ae-email-configure.png b/assets/images/enterprise/configuration/ae-email-configure.png new file mode 100644 index 000000000000..b82b85959428 Binary files /dev/null and b/assets/images/enterprise/configuration/ae-email-configure.png differ diff --git a/assets/images/enterprise/configuration/ae-enable-email-configure.png b/assets/images/enterprise/configuration/ae-enable-email-configure.png new file mode 100644 index 000000000000..796bc6f9a233 Binary files /dev/null and b/assets/images/enterprise/configuration/ae-enable-email-configure.png differ diff --git a/assets/images/enterprise/configuration/ae-send-test-email.png b/assets/images/enterprise/configuration/ae-send-test-email.png new file mode 100644 index 000000000000..74c1d3ec12bd Binary files /dev/null and b/assets/images/enterprise/configuration/ae-send-test-email.png differ diff --git a/assets/images/enterprise/configuration/ae-test-email.png b/assets/images/enterprise/configuration/ae-test-email.png new file mode 100644 index 000000000000..e88dc8bb167f Binary files /dev/null and b/assets/images/enterprise/configuration/ae-test-email.png differ diff --git a/assets/images/enterprise/configuration/enterprise-account-email-tab.png b/assets/images/enterprise/configuration/enterprise-account-email-tab.png new file mode 100644 index 000000000000..b84ceae136fc Binary files /dev/null and b/assets/images/enterprise/configuration/enterprise-account-email-tab.png differ diff --git a/assets/images/enterprise/github-ae/organizations/security-and-analysis-disable-or-enable-all-ghae.png b/assets/images/enterprise/github-ae/organizations/security-and-analysis-disable-or-enable-all-ghae.png new file mode 100644 index 000000000000..3765b1155fce Binary files /dev/null and b/assets/images/enterprise/github-ae/organizations/security-and-analysis-disable-or-enable-all-ghae.png differ diff --git a/assets/images/enterprise/github-ae/organizations/security-and-analysis-enable-or-disable-secret-scanning-checkbox-ghae.png b/assets/images/enterprise/github-ae/organizations/security-and-analysis-enable-or-disable-secret-scanning-checkbox-ghae.png new file mode 100644 index 000000000000..5f4f5d34f4ff Binary files /dev/null and b/assets/images/enterprise/github-ae/organizations/security-and-analysis-enable-or-disable-secret-scanning-checkbox-ghae.png differ diff --git a/assets/images/enterprise/github-ae/organizations/security-and-analysis-enable-secret-scanning-existing-repos-ghae.png b/assets/images/enterprise/github-ae/organizations/security-and-analysis-enable-secret-scanning-existing-repos-ghae.png new file mode 100644 index 000000000000..c7248c0415c5 Binary files /dev/null and b/assets/images/enterprise/github-ae/organizations/security-and-analysis-enable-secret-scanning-existing-repos-ghae.png differ diff --git a/assets/images/enterprise/github-ae/repository/enable-ghas-confirmation-ghae.png b/assets/images/enterprise/github-ae/repository/enable-ghas-confirmation-ghae.png new file mode 100644 index 000000000000..b603c02f3011 Binary files /dev/null and b/assets/images/enterprise/github-ae/repository/enable-ghas-confirmation-ghae.png differ diff --git a/assets/images/enterprise/github-ae/repository/enable-ghas-ghae.png b/assets/images/enterprise/github-ae/repository/enable-ghas-ghae.png new file mode 100644 index 000000000000..8387f81d6423 Binary files /dev/null and b/assets/images/enterprise/github-ae/repository/enable-ghas-ghae.png differ diff --git a/assets/images/enterprise/github-ae/repository/enable-ghas-secret-scanning-ghae.png b/assets/images/enterprise/github-ae/repository/enable-ghas-secret-scanning-ghae.png new file mode 100644 index 000000000000..806400be61c3 Binary files /dev/null and b/assets/images/enterprise/github-ae/repository/enable-ghas-secret-scanning-ghae.png differ diff --git a/assets/images/enterprise/github-ae/repository/enable-secret-scanning-ghae.png b/assets/images/enterprise/github-ae/repository/enable-secret-scanning-ghae.png new file mode 100644 index 000000000000..2a076623bc5f Binary files /dev/null and b/assets/images/enterprise/github-ae/repository/enable-secret-scanning-ghae.png differ diff --git a/assets/images/enterprise/github-ae/repository/secret-scanning-click-alert-ghae.png b/assets/images/enterprise/github-ae/repository/secret-scanning-click-alert-ghae.png new file mode 100644 index 000000000000..c10b46c96ae6 Binary files /dev/null and b/assets/images/enterprise/github-ae/repository/secret-scanning-click-alert-ghae.png differ diff --git a/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-person-or-team-search-ghae.png b/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-person-or-team-search-ghae.png new file mode 100644 index 000000000000..01aba08f891f Binary files /dev/null and b/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-person-or-team-search-ghae.png differ diff --git a/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-save-changes-ghae.png b/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-save-changes-ghae.png new file mode 100644 index 000000000000..e05d591e6698 Binary files /dev/null and b/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-save-changes-ghae.png differ diff --git a/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-username-x-ghae.png b/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-username-x-ghae.png new file mode 100644 index 000000000000..c78c07267766 Binary files /dev/null and b/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-username-x-ghae.png differ diff --git a/assets/images/enterprise/github-ae/repository/sidebar-secrets-ghae.png b/assets/images/enterprise/github-ae/repository/sidebar-secrets-ghae.png new file mode 100644 index 000000000000..c2b799d7817c Binary files /dev/null and b/assets/images/enterprise/github-ae/repository/sidebar-secrets-ghae.png differ diff --git a/assets/images/enterprise/github-ae/settings/access-token-scopes-for-ghae.png b/assets/images/enterprise/github-ae/settings/access-token-scopes-for-ghae.png new file mode 100644 index 000000000000..31015adef671 Binary files /dev/null and b/assets/images/enterprise/github-ae/settings/access-token-scopes-for-ghae.png differ diff --git a/assets/images/enterprise/github-ae/teams/choose-an-idp-group.png b/assets/images/enterprise/github-ae/teams/choose-an-idp-group.png new file mode 100644 index 000000000000..7c6f730d556f Binary files /dev/null and b/assets/images/enterprise/github-ae/teams/choose-an-idp-group.png differ diff --git a/assets/images/enterprise/github-ae/teams/unselect-idp-group.png b/assets/images/enterprise/github-ae/teams/unselect-idp-group.png new file mode 100644 index 000000000000..a9cc3d1ffef5 Binary files /dev/null and b/assets/images/enterprise/github-ae/teams/unselect-idp-group.png differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/business-accounts/settings-options-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/business-accounts/settings-options-tab.png deleted file mode 100644 index f7e163d0333e..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/business-accounts/settings-options-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/enterprises/license.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/enterprises/license.png deleted file mode 100644 index 679a7a631067..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/enterprises/license.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/management-console/management-console-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/management-console/management-console-tab.png deleted file mode 100644 index 103434c7f19d..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/management-console/management-console-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/management-console/save-settings.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/management-console/save-settings.png deleted file mode 100644 index 722e49a05d30..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/management-console/save-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/management-console/sidebar-authentication.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/management-console/sidebar-authentication.png deleted file mode 100644 index 68e2fb5ff54a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/management-console/sidebar-authentication.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/access-new-settings.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/access-new-settings.png deleted file mode 100644 index 1cb09395a1a3..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/access-new-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/edit-message.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/edit-message.png deleted file mode 100644 index d7a61a45622a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/edit-message.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/enable-vulnerability-scanning-in-repositories.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/enable-vulnerability-scanning-in-repositories.png deleted file mode 100644 index 12a788db07e7..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/enable-vulnerability-scanning-in-repositories.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/enterprise-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/enterprise-tab.png deleted file mode 100644 index f39403c6653f..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/enterprise-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/repo/repo-security-top-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/repo/repo-security-top-tab.png deleted file mode 100644 index fe43aa9de0c5..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/repo/repo-security-top-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png deleted file mode 100644 index 1dd271ada478..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/suspend.png b/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/suspend.png deleted file mode 100644 index 433cbf69cd1e..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/enterprise/site-admin-settings/suspend.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/environments-sidebar.png b/assets/images/enterprise/legacy-format/2.20/assets/images/environments-sidebar.png deleted file mode 100644 index cbc82f139e32..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/environments-sidebar.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/github-apps/github_apps_delete_key.png b/assets/images/enterprise/legacy-format/2.20/assets/images/github-apps/github_apps_delete_key.png deleted file mode 100644 index 5dc7807cf9a6..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/github-apps/github_apps_delete_key.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/github-apps/github_apps_private_key_fingerprint.png b/assets/images/enterprise/legacy-format/2.20/assets/images/github-apps/github_apps_private_key_fingerprint.png deleted file mode 100644 index 0748413ffe67..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/github-apps/github_apps_private_key_fingerprint.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/branch/branch-creation-text-box.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/branch/branch-creation-text-box.png deleted file mode 100644 index f95a7942b11a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/branch/branch-creation-text-box.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/branch/branch-selection-dropdown.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/branch/branch-selection-dropdown.png deleted file mode 100644 index 4e0bde97367f..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/branch/branch-selection-dropdown.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/branches/branches-link.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/branches/branches-link.png deleted file mode 100644 index dda96dadb20f..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/branches/branches-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/branches/branches-overview-atom.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/branches/branches-overview-atom.png deleted file mode 100644 index 9c3e7dd79167..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/branches/branches-overview-atom.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/billing-license-info.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/billing-license-info.png deleted file mode 100644 index 95b5a020949a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/billing-license-info.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png deleted file mode 100644 index 3c33270e8571..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/enterprise-account-settings-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/enterprise-account-settings-tab.png deleted file mode 100644 index 90da18a2225f..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/enterprise-account-settings-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/upload-ghe-server-usage-link.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/upload-ghe-server-usage-link.png deleted file mode 100644 index f01f6df79d33..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/business-accounts/upload-ghe-server-usage-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/commits/Commit-master-label.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/commits/Commit-master-label.png deleted file mode 100644 index 1b0bd0322068..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/commits/Commit-master-label.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/mac-choose-preferences.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/mac-choose-preferences.png deleted file mode 100644 index de1f5cacf168..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/mac-choose-preferences.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/push-origin-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/push-origin-button.png deleted file mode 100644 index 3f23fa7af4c6..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/push-origin-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/sign-in-button-browser.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/sign-in-button-browser.png deleted file mode 100644 index 5019df8c1a1b..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/sign-in-button-browser.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/windows-choose-options.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/windows-choose-options.png deleted file mode 100644 index d780876ee806..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/desktop/windows-choose-options.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/education/upgrade-org-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/education/upgrade-org-button.png deleted file mode 100644 index 6080201baa93..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/education/upgrade-org-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/graphs/dependents_graph.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/graphs/dependents_graph.png deleted file mode 100644 index f70b6bf9c901..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/graphs/dependents_graph.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/issues/delete-issue.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/issues/delete-issue.png deleted file mode 100644 index 1ce65f85564a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/issues/delete-issue.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/notifications/notifications_general_existence_indicator.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/notifications/notifications_general_existence_indicator.png deleted file mode 100644 index af949a6f41d1..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/notifications/notifications_general_existence_indicator.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/disallow-members-to-change-repo-visibility.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/disallow-members-to-change-repo-visibility.png deleted file mode 100644 index 988cc9562bde..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/disallow-members-to-change-repo-visibility.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/name-of-business.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/name-of-business.png deleted file mode 100644 index ffc26c3f9399..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/name-of-business.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/org-settings-member-privileges.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/org-settings-member-privileges.png deleted file mode 100644 index bfd09369ebcd..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/org-settings-member-privileges.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/org-settings-security-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/org-settings-security-tab.png deleted file mode 100644 index ae4e9ccf298b..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/org-settings-security-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/organization-belongs-to.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/organization-belongs-to.png deleted file mode 100644 index 8a57e382d497..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/organization-belongs-to.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/organization-settings-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/organization-settings-tab.png deleted file mode 100644 index 35c18741e531..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/organization-settings-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/people-tab-invite-member.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/people-tab-invite-member.png deleted file mode 100644 index 9677218aadf9..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/people-tab-invite-member.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/repo-labels-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/repo-labels-tab.png deleted file mode 100644 index df9402d85515..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/repo-labels-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/trash-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/trash-button.png deleted file mode 100644 index ab46a09ec512..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/organizations/trash-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/package-registry/packages-link.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/package-registry/packages-link.png deleted file mode 100644 index e9e52bfcd649..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/package-registry/packages-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/click-pages-url-to-preview.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/click-pages-url-to-preview.png deleted file mode 100644 index 61437b8be575..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/click-pages-url-to-preview.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/create-repository-name-pages.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/create-repository-name-pages.png deleted file mode 100644 index 36ba1e59feb8..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/create-repository-name-pages.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/publishing-source-drop-down.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/publishing-source-drop-down.png deleted file mode 100644 index 04be864683e5..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/publishing-source-drop-down.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/save-custom-domain.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/save-custom-domain.png deleted file mode 100644 index 8670b4b8ee27..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pages/save-custom-domain.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/display-pro-badge-checkbox.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/display-pro-badge-checkbox.png deleted file mode 100644 index 877dfd6bbe08..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/display-pro-badge-checkbox.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/profile-block-or-report-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/profile-block-or-report-button.png deleted file mode 100644 index a4adf3ee72d5..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/profile-block-or-report-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/profile_orgs_box.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/profile_orgs_box.png deleted file mode 100644 index 6b7ff4d08ee4..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/profile_orgs_box.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/top_right_avatar.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/top_right_avatar.png deleted file mode 100644 index a3893678edac..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/profile/top_right_avatar.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/projects/team-discussions-comment-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/projects/team-discussions-comment-button.png deleted file mode 100644 index b253bd099a10..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/projects/team-discussions-comment-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/projects/team-discussions-comment.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/projects/team-discussions-comment.png deleted file mode 100644 index bf40d3a62f6a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/projects/team-discussions-comment.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/projects/team-discussions-privacy-menu.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/projects/team-discussions-privacy-menu.png deleted file mode 100644 index e1e2b184043c..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/projects/team-discussions-privacy-menu.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/branch-dropdown.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/branch-dropdown.png deleted file mode 100644 index 7ba69b1f1ddf..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/branch-dropdown.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/choose-base-and-compare-branches.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/choose-base-and-compare-branches.png deleted file mode 100644 index c9ffd3f1b0cb..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/choose-base-and-compare-branches.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/choose-base-fork-and-branch.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/choose-base-fork-and-branch.png deleted file mode 100644 index 451035484703..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/choose-base-fork-and-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/choose-head-fork-compare-branch.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/choose-head-fork-compare-branch.png deleted file mode 100644 index 1db5fe09a6f4..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/choose-head-fork-compare-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/compare-across-forks-link.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/compare-across-forks-link.png deleted file mode 100644 index 6676a282cbe1..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/compare-across-forks-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/compare-branch-example.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/compare-branch-example.png deleted file mode 100644 index b3831912b2e6..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/compare-branch-example.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-edit-base-branch.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-edit-base-branch.png deleted file mode 100644 index 9e87a5dc4dec..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-edit-base-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-edit.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-edit.png deleted file mode 100644 index bd05b7b0e62a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-edit.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-review-edit-branch.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-review-edit-branch.png deleted file mode 100644 index 0382a63fcfe6..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-review-edit-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-start-review-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-start-review-button.png deleted file mode 100644 index 1620899cd026..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/pull-request-start-review-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/revert-pull-request-link.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/revert-pull-request-link.png deleted file mode 100644 index e46cf9d51289..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/pull_requests/revert-pull-request-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/release-link.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/release-link.png deleted file mode 100644 index 4fe6ea286b54..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/release-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/release-name-link.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/release-name-link.png deleted file mode 100644 index 27108a2b4e7c..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/release-name-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/releases-tag-branch.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/releases-tag-branch.png deleted file mode 100644 index ff613680dfd0..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/releases-tag-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/releases-tag-version.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/releases-tag-version.png deleted file mode 100644 index 693573cd5523..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/releases/releases-tag-version.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-review-required-code-owner.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-review-required-code-owner.png deleted file mode 100644 index 715495c21d73..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-review-required-code-owner.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-review-required-dismissals.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-review-required-dismissals.png deleted file mode 100644 index 1c78f9dcd331..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-review-required-dismissals.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-reviews-required-dismiss-stale.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-reviews-required-dismiss-stale.png deleted file mode 100644 index 28014adc212f..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-reviews-required-dismiss-stale.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-reviews-required.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-reviews-required.png deleted file mode 100644 index 5a98890ecb95..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/PR-reviews-required.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/add-topic-form.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/add-topic-form.png deleted file mode 100644 index 02dbf8be424e..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/add-topic-form.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/choose-commit-branch.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/choose-commit-branch.png deleted file mode 100644 index 2e59501633e5..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/choose-commit-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/choose-reason-for-hiding-comment-ghe.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/choose-reason-for-hiding-comment-ghe.png deleted file mode 100644 index 2d72784233c5..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/choose-reason-for-hiding-comment-ghe.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create-commit-open-readme.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create-commit-open-readme.png deleted file mode 100644 index bf622bcbd849..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create-commit-open-readme.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create-repository-owner.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create-repository-owner.png deleted file mode 100644 index 8988cc96a64a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create-repository-owner.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create-repository-public-private.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create-repository-public-private.png deleted file mode 100644 index fab4254b7d7b..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create-repository-public-private.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create_new_file.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create_new_file.png deleted file mode 100644 index a065ca72f1f5..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/create_new_file.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/https-url-clone.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/https-url-clone.png deleted file mode 100644 index cae17288875c..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/https-url-clone.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/include-admins-protected-branches.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/include-admins-protected-branches.png deleted file mode 100644 index c116702484dc..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/include-admins-protected-branches.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/initialize-with-readme.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/initialize-with-readme.png deleted file mode 100644 index 221178f55e31..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/initialize-with-readme.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/issue-template-commit-message-field.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/issue-template-commit-message-field.png deleted file mode 100644 index 55121147dc5d..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/issue-template-commit-message-field.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/issue-template-commit-to-master-or-open-pull-request.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/issue-template-commit-to-master-or-open-pull-request.png deleted file mode 100644 index a234ab3480b4..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/issue-template-commit-to-master-or-open-pull-request.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/manage-access-invite-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/manage-access-invite-button.png deleted file mode 100644 index 9569973c62a1..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/manage-access-invite-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/new-file-commit-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/new-file-commit-button.png deleted file mode 100644 index 0d0444f39504..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/new-file-commit-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/number-of-required-review-approvals.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/number-of-required-review-approvals.png deleted file mode 100644 index 23c4d4ffefeb..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/number-of-required-review-approvals.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/os-repo-with-topics.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/os-repo-with-topics.png deleted file mode 100644 index e2aba0e14810..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/os-repo-with-topics.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/propose-file-change-quick-pull.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/propose-file-change-quick-pull.png deleted file mode 100644 index e0f91e56dd6a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/propose-file-change-quick-pull.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/protecting-branch-loose-status.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/protecting-branch-loose-status.png deleted file mode 100644 index eee5f254b9e6..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/protecting-branch-loose-status.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repo-actions-settings.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repo-actions-settings.png deleted file mode 100644 index fe1ae3308b1b..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repo-actions-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repo-with-readme.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repo-with-readme.png deleted file mode 100644 index 89594e645ef0..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repo-with-readme.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repository-options-branch.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repository-options-branch.png deleted file mode 100644 index fdf36c69c04f..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repository-options-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repository-options-defaultbranch.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repository-options-defaultbranch.png deleted file mode 100644 index d45e6ee8caec..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/repository-options-defaultbranch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/require-signed-commits.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/require-signed-commits.png deleted file mode 100644 index 6aba04bf4431..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/require-signed-commits.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/required-linear-history.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/required-linear-history.png deleted file mode 100644 index b7a3201ffb4b..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/required-linear-history.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/required-status-checks.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/required-status-checks.png deleted file mode 100644 index 18cd40fc3137..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/required-status-checks.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/required-statuses-list.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/required-statuses-list.png deleted file mode 100644 index 41880593baaa..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/required-statuses-list.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/restrict-branch-search.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/restrict-branch-search.png deleted file mode 100644 index a9cd95596398..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/restrict-branch-search.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/restrict-branch.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/restrict-branch.png deleted file mode 100644 index 4129635888d9..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/restrict-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/run-name.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/run-name.png deleted file mode 100644 index bf8988b4aecc..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/run-name.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/upload-files-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/upload-files-button.png deleted file mode 100644 index a77f7974e225..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/upload-files-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/workflow-sidebar.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/workflow-sidebar.png deleted file mode 100644 index 1c0597f14920..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/workflow-sidebar.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/write-commit-message-co-author-trailer.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/write-commit-message-co-author-trailer.png deleted file mode 100644 index 92aebb55dbe7..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/repository/write-commit-message-co-author-trailer.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/search/find-file-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/search/find-file-button.png deleted file mode 100644 index 156aa39e477e..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/search/find-file-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/search/find-file-search-field.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/search/find-file-search-field.png deleted file mode 100644 index 612a6c6863c0..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/search/find-file-search-field.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/search/search-field.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/search/search-field.png deleted file mode 100644 index 68f542a85195..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/search/search-field.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/security/advisories-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/security/advisories-tab.png deleted file mode 100644 index a3659d0f66fd..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/security/advisories-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/security/security-advisory-description.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/security/security-advisory-description.png deleted file mode 100644 index ac89833db992..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/security/security-advisory-description.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/security/security-advisory-metadata.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/security/security-advisory-metadata.png deleted file mode 100644 index 9a0f83e105d5..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/security/security-advisory-metadata.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/actions-runner-remove.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/actions-runner-remove.png deleted file mode 100644 index 9a82a91c8e31..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/actions-runner-remove.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/audit-log-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/audit-log-tab.png deleted file mode 100644 index c310a8b68deb..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/audit-log-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/scheduled-reminders-prs-without-requests.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/scheduled-reminders-prs-without-requests.png deleted file mode 100644 index 251e134dc646..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/scheduled-reminders-prs-without-requests.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/settings-sidebar-account-settings.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/settings-sidebar-account-settings.png deleted file mode 100644 index cf8a7402e9e7..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/settings-sidebar-account-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/settings-sidebar-ssh-keys.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/settings-sidebar-ssh-keys.png deleted file mode 100644 index c48d203519c3..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/settings-sidebar-ssh-keys.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/settings-ssh-key-review.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/settings-ssh-key-review.png deleted file mode 100644 index 992d1307784b..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/settings-ssh-key-review.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/userbar-account-settings.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/userbar-account-settings.png deleted file mode 100644 index f54ce518cd26..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/settings/userbar-account-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/setup/keychain-access.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/setup/keychain-access.png deleted file mode 100644 index 7628dd83b492..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/setup/keychain-access.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/activity-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/activity-tab.png deleted file mode 100644 index c6497f73fffa..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/activity-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/description-highlighted-org-members.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/description-highlighted-org-members.png deleted file mode 100644 index 7f89ae045da6..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/description-highlighted-org-members.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/edit-org-members-profile-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/edit-org-members-profile-button.png deleted file mode 100644 index a20c0818636b..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/edit-org-members-profile-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/introduction-box.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/introduction-box.png deleted file mode 100644 index 8130b22c76c7..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/introduction-box.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/manage-your-sponsorship-button.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/manage-your-sponsorship-button.png deleted file mode 100644 index 3c094ea2fcf4..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/manage-your-sponsorship-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/payouts-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/payouts-tab.png deleted file mode 100644 index f24e0e6e565c..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/payouts-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/profile-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/profile-tab.png deleted file mode 100644 index 6a04eb6a0cc0..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/profile-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/select-highlighted-org-members.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/select-highlighted-org-members.png deleted file mode 100644 index 1f7a488b4174..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/select-highlighted-org-members.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/sponsor-tiers-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/sponsor-tiers-tab.png deleted file mode 100644 index 14131e4ae3a7..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/sponsor-tiers-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/sponsors-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/sponsors-tab.png deleted file mode 100644 index 5ca1f6a4310d..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/sponsors-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/updates-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/updates-tab.png deleted file mode 100644 index 023ad329769b..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/updates-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/webhooks-tab.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/webhooks-tab.png deleted file mode 100644 index d9569c5cd1e7..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/sponsors/webhooks-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/teams/choose-an-idp-group.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/teams/choose-an-idp-group.png deleted file mode 100644 index 233aeff8898e..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/teams/choose-an-idp-group.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/teams/enable-team-synchronization.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/teams/enable-team-synchronization.png deleted file mode 100644 index 92b9da1bb52b..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/teams/enable-team-synchronization.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.20/assets/images/help/teams/list-of-members-selected-bulk.png b/assets/images/enterprise/legacy-format/2.20/assets/images/help/teams/list-of-members-selected-bulk.png deleted file mode 100644 index d1bd946c7fa7..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.20/assets/images/help/teams/list-of-members-selected-bulk.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/business-accounts/settings-options-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/business-accounts/settings-options-tab.png deleted file mode 100644 index f7e163d0333e..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/business-accounts/settings-options-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/enterprises/license.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/enterprises/license.png deleted file mode 100644 index 679a7a631067..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/enterprises/license.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/management-console/management-console-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/management-console/management-console-tab.png deleted file mode 100644 index 103434c7f19d..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/management-console/management-console-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/management-console/save-settings.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/management-console/save-settings.png deleted file mode 100644 index 722e49a05d30..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/management-console/save-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/management-console/sidebar-authentication.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/management-console/sidebar-authentication.png deleted file mode 100644 index 68e2fb5ff54a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/management-console/sidebar-authentication.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/access-new-settings.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/access-new-settings.png deleted file mode 100644 index 1cb09395a1a3..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/access-new-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/edit-message.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/edit-message.png deleted file mode 100644 index d7a61a45622a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/edit-message.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/enterprise-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/enterprise-tab.png deleted file mode 100644 index f39403c6653f..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/enterprise-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/repo/repo-security-top-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/repo/repo-security-top-tab.png deleted file mode 100644 index fe43aa9de0c5..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/repo/repo-security-top-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png deleted file mode 100644 index 1dd271ada478..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/suspend.png b/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/suspend.png deleted file mode 100644 index 433cbf69cd1e..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/enterprise/site-admin-settings/suspend.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/environments-sidebar.png b/assets/images/enterprise/legacy-format/2.21/assets/images/environments-sidebar.png deleted file mode 100644 index cbc82f139e32..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/environments-sidebar.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/github-apps/github_apps_delete_key.png b/assets/images/enterprise/legacy-format/2.21/assets/images/github-apps/github_apps_delete_key.png deleted file mode 100644 index 5dc7807cf9a6..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/github-apps/github_apps_delete_key.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/github-apps/github_apps_private_key_fingerprint.png b/assets/images/enterprise/legacy-format/2.21/assets/images/github-apps/github_apps_private_key_fingerprint.png deleted file mode 100644 index 0748413ffe67..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/github-apps/github_apps_private_key_fingerprint.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/branch/branch-creation-text-box.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/branch/branch-creation-text-box.png deleted file mode 100644 index f95a7942b11a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/branch/branch-creation-text-box.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/branch/branch-selection-dropdown.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/branch/branch-selection-dropdown.png deleted file mode 100644 index 4e0bde97367f..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/branch/branch-selection-dropdown.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/branches/branches-link.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/branches/branches-link.png deleted file mode 100644 index dda96dadb20f..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/branches/branches-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/branches/branches-overview-atom.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/branches/branches-overview-atom.png deleted file mode 100644 index 9c3e7dd79167..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/branches/branches-overview-atom.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/business-accounts/billing-license-info.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/business-accounts/billing-license-info.png deleted file mode 100644 index bd5e610ecefd..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/business-accounts/billing-license-info.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png deleted file mode 100644 index 3c33270e8571..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/business-accounts/enterprise-account-settings-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/business-accounts/enterprise-account-settings-tab.png deleted file mode 100644 index 90da18a2225f..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/business-accounts/enterprise-account-settings-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png deleted file mode 100644 index b4081b262e4e..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/commits/Commit-master-label.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/commits/Commit-master-label.png deleted file mode 100644 index 1b0bd0322068..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/commits/Commit-master-label.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/mac-choose-preferences.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/mac-choose-preferences.png deleted file mode 100644 index 45494d166ef3..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/mac-choose-preferences.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/push-origin-button.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/push-origin-button.png deleted file mode 100644 index 3f23fa7af4c6..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/push-origin-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/sign-in-button-browser.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/sign-in-button-browser.png deleted file mode 100644 index 5019df8c1a1b..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/sign-in-button-browser.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/windows-choose-options.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/windows-choose-options.png deleted file mode 100644 index d780876ee806..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/desktop/windows-choose-options.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/graphs/dependents_graph.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/graphs/dependents_graph.png deleted file mode 100644 index f70b6bf9c901..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/graphs/dependents_graph.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/issues/delete-issue.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/issues/delete-issue.png deleted file mode 100644 index 1ce65f85564a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/issues/delete-issue.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/disallow-members-to-change-repo-visibility.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/disallow-members-to-change-repo-visibility.png deleted file mode 100644 index 988cc9562bde..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/disallow-members-to-change-repo-visibility.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/org-settings-member-privileges.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/org-settings-member-privileges.png deleted file mode 100644 index bfd09369ebcd..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/org-settings-member-privileges.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/org-settings-security-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/org-settings-security-tab.png deleted file mode 100644 index ae4e9ccf298b..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/org-settings-security-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/organization-settings-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/organization-settings-tab.png deleted file mode 100644 index 35c18741e531..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/organization-settings-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/repo-labels-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/repo-labels-tab.png deleted file mode 100644 index df9402d85515..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/organizations/repo-labels-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/package-registry/packages-link.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/package-registry/packages-link.png deleted file mode 100644 index e9e52bfcd649..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/package-registry/packages-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/click-pages-url-to-preview.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/click-pages-url-to-preview.png deleted file mode 100644 index 61437b8be575..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/click-pages-url-to-preview.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/create-repository-name-pages.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/create-repository-name-pages.png deleted file mode 100644 index 36ba1e59feb8..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/create-repository-name-pages.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/publishing-source-drop-down.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/publishing-source-drop-down.png deleted file mode 100644 index 04be864683e5..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/publishing-source-drop-down.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/save-custom-domain.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/save-custom-domain.png deleted file mode 100644 index 8670b4b8ee27..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pages/save-custom-domain.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/display-pro-badge-checkbox.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/display-pro-badge-checkbox.png deleted file mode 100644 index 877dfd6bbe08..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/display-pro-badge-checkbox.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/profile-block-or-report-button.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/profile-block-or-report-button.png deleted file mode 100644 index a4adf3ee72d5..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/profile-block-or-report-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/profile_orgs_box.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/profile_orgs_box.png deleted file mode 100644 index 6b7ff4d08ee4..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/profile_orgs_box.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/top_right_avatar.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/top_right_avatar.png deleted file mode 100644 index a3893678edac..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/profile/top_right_avatar.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/projects/team-discussions-comment-button.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/projects/team-discussions-comment-button.png deleted file mode 100644 index 56627406c921..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/projects/team-discussions-comment-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/projects/team-discussions-comment.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/projects/team-discussions-comment.png deleted file mode 100644 index bf40d3a62f6a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/projects/team-discussions-comment.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/projects/team-discussions-privacy-menu.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/projects/team-discussions-privacy-menu.png deleted file mode 100644 index e1e2b184043c..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/projects/team-discussions-privacy-menu.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/branch-dropdown.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/branch-dropdown.png deleted file mode 100644 index 7ba69b1f1ddf..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/branch-dropdown.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/choose-base-and-compare-branches.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/choose-base-and-compare-branches.png deleted file mode 100644 index c9ffd3f1b0cb..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/choose-base-and-compare-branches.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/choose-base-fork-and-branch.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/choose-base-fork-and-branch.png deleted file mode 100644 index 451035484703..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/choose-base-fork-and-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/choose-head-fork-compare-branch.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/choose-head-fork-compare-branch.png deleted file mode 100644 index 1db5fe09a6f4..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/choose-head-fork-compare-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/compare-across-forks-link.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/compare-across-forks-link.png deleted file mode 100644 index 6676a282cbe1..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/compare-across-forks-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/compare-branch-example.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/compare-branch-example.png deleted file mode 100644 index b3831912b2e6..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/compare-branch-example.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-edit-base-branch.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-edit-base-branch.png deleted file mode 100644 index 9e87a5dc4dec..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-edit-base-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-edit.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-edit.png deleted file mode 100644 index bd05b7b0e62a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-edit.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-review-edit-branch.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-review-edit-branch.png deleted file mode 100644 index 0382a63fcfe6..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-review-edit-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-start-review-button.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-start-review-button.png deleted file mode 100644 index 1620899cd026..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/pull-request-start-review-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/revert-pull-request-link.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/revert-pull-request-link.png deleted file mode 100644 index 57e7fdade011..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/pull_requests/revert-pull-request-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/releases/release-link.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/releases/release-link.png deleted file mode 100644 index 4fe6ea286b54..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/releases/release-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/releases/releases-tag-branch.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/releases/releases-tag-branch.png deleted file mode 100644 index ff613680dfd0..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/releases/releases-tag-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/releases/releases-tag-version.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/releases/releases-tag-version.png deleted file mode 100644 index 693573cd5523..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/releases/releases-tag-version.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/add-topic-form.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/add-topic-form.png deleted file mode 100644 index 02dbf8be424e..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/add-topic-form.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/choose-commit-branch.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/choose-commit-branch.png deleted file mode 100644 index 2e59501633e5..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/choose-commit-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/code-scanning-click-alert.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/code-scanning-click-alert.png deleted file mode 100644 index f1ea07b843d2..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/code-scanning-click-alert.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create-commit-open-readme.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create-commit-open-readme.png deleted file mode 100644 index dc0fec4ace46..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create-commit-open-readme.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create-repository-owner.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create-repository-owner.png deleted file mode 100644 index 8988cc96a64a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create-repository-owner.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create-repository-public-private.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create-repository-public-private.png deleted file mode 100644 index fab4254b7d7b..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create-repository-public-private.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create_new_file.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create_new_file.png deleted file mode 100644 index a065ca72f1f5..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/create_new_file.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/https-url-clone.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/https-url-clone.png deleted file mode 100644 index cae17288875c..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/https-url-clone.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/include-all-branches.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/include-all-branches.png deleted file mode 100644 index 4d81d46872a6..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/include-all-branches.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/initialize-with-readme.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/initialize-with-readme.png deleted file mode 100644 index 221178f55e31..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/initialize-with-readme.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/issue-template-commit-message-field.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/issue-template-commit-message-field.png deleted file mode 100644 index 55121147dc5d..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/issue-template-commit-message-field.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/issue-template-commit-to-master-or-open-pull-request.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/issue-template-commit-to-master-or-open-pull-request.png deleted file mode 100644 index a234ab3480b4..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/issue-template-commit-to-master-or-open-pull-request.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/new-file-commit-button.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/new-file-commit-button.png deleted file mode 100644 index 0d0444f39504..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/new-file-commit-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/os-repo-with-topics.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/os-repo-with-topics.png deleted file mode 100644 index e2aba0e14810..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/os-repo-with-topics.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/propose-file-change-quick-pull.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/propose-file-change-quick-pull.png deleted file mode 100644 index e0f91e56dd6a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/propose-file-change-quick-pull.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repo-actions-settings.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repo-actions-settings.png deleted file mode 100644 index fe1ae3308b1b..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repo-actions-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repo-with-readme.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repo-with-readme.png deleted file mode 100644 index 89594e645ef0..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repo-with-readme.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repository-options-branch.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repository-options-branch.png deleted file mode 100644 index fdf36c69c04f..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repository-options-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repository-options-defaultbranch.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repository-options-defaultbranch.png deleted file mode 100644 index d45e6ee8caec..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/repository-options-defaultbranch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/run-name.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/run-name.png deleted file mode 100644 index bf8988b4aecc..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/run-name.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/upload-files-button.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/upload-files-button.png deleted file mode 100644 index a77f7974e225..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/upload-files-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/workflow-sidebar.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/workflow-sidebar.png deleted file mode 100644 index 1c0597f14920..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/workflow-sidebar.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/write-commit-message-co-author-trailer.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/write-commit-message-co-author-trailer.png deleted file mode 100644 index 92aebb55dbe7..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/repository/write-commit-message-co-author-trailer.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/saml/okta-provisioning-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/saml/okta-provisioning-tab.png deleted file mode 100644 index 6a7ea9ef9041..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/saml/okta-provisioning-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/search/find-file-button.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/search/find-file-button.png deleted file mode 100644 index 156aa39e477e..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/search/find-file-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/search/find-file-search-field.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/search/find-file-search-field.png deleted file mode 100644 index 612a6c6863c0..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/search/find-file-search-field.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/actions-runner-manage-permissions.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/actions-runner-manage-permissions.png deleted file mode 100644 index 214be7f52959..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/actions-runner-manage-permissions.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/actions-runner-remove.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/actions-runner-remove.png deleted file mode 100644 index ae62f5b6e436..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/actions-runner-remove.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/audit-log-tab.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/audit-log-tab.png deleted file mode 100644 index c310a8b68deb..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/audit-log-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/settings-sidebar-account-settings.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/settings-sidebar-account-settings.png deleted file mode 100644 index cf8a7402e9e7..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/settings-sidebar-account-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/settings-sidebar-ssh-keys.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/settings-sidebar-ssh-keys.png deleted file mode 100644 index c48d203519c3..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/settings-sidebar-ssh-keys.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/settings-ssh-key-review.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/settings-ssh-key-review.png deleted file mode 100644 index 992d1307784b..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/settings-ssh-key-review.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/userbar-account-settings.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/userbar-account-settings.png deleted file mode 100644 index f54ce518cd26..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/settings/userbar-account-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/setup/keychain-access.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/setup/keychain-access.png deleted file mode 100644 index 7628dd83b492..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/setup/keychain-access.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.21/assets/images/help/sponsors/manage-your-sponsorship-button.png b/assets/images/enterprise/legacy-format/2.21/assets/images/help/sponsors/manage-your-sponsorship-button.png deleted file mode 100644 index 3c094ea2fcf4..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.21/assets/images/help/sponsors/manage-your-sponsorship-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/business-accounts/settings-options-tab.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/business-accounts/settings-options-tab.png deleted file mode 100644 index f7e163d0333e..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/business-accounts/settings-options-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/code-scanning-disable.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/code-scanning-disable.png deleted file mode 100644 index 3b5fbd47c959..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/code-scanning-disable.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/enable-code-scanning-checkbox.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/enable-code-scanning-checkbox.png deleted file mode 100644 index 396a52387f2c..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/enable-code-scanning-checkbox.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/management-console-tab.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/management-console-tab.png deleted file mode 100644 index 103434c7f19d..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/management-console-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/sidebar-advanced-security.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/sidebar-advanced-security.png deleted file mode 100644 index dc1097dae202..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/sidebar-advanced-security.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/sidebar-authentication.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/sidebar-authentication.png deleted file mode 100644 index 68e2fb5ff54a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/management-console/sidebar-authentication.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/access-new-settings.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/access-new-settings.png deleted file mode 100644 index 1cb09395a1a3..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/access-new-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/add-announcement-button.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/add-announcement-button.png deleted file mode 100644 index 1a8822138d28..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/add-announcement-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/edit-message.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/edit-message.png deleted file mode 100644 index d7a61a45622a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/edit-message.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/enterprise-tab.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/enterprise-tab.png deleted file mode 100644 index f39403c6653f..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/enterprise-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/repo/repo-security-top-tab.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/repo/repo-security-top-tab.png deleted file mode 100644 index fe43aa9de0c5..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/repo/repo-security-top-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png deleted file mode 100644 index 1dd271ada478..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/suspend.png b/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/suspend.png deleted file mode 100644 index 433cbf69cd1e..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/enterprise/site-admin-settings/suspend.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/environments-sidebar.png b/assets/images/enterprise/legacy-format/2.22/assets/images/environments-sidebar.png deleted file mode 100644 index cbc82f139e32..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/environments-sidebar.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/github-apps/github_apps_delete_key.png b/assets/images/enterprise/legacy-format/2.22/assets/images/github-apps/github_apps_delete_key.png deleted file mode 100644 index 5dc7807cf9a6..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/github-apps/github_apps_delete_key.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/github-apps/github_apps_private_key_fingerprint.png b/assets/images/enterprise/legacy-format/2.22/assets/images/github-apps/github_apps_private_key_fingerprint.png deleted file mode 100644 index 0748413ffe67..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/github-apps/github_apps_private_key_fingerprint.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/branch/branch-creation-text-box.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/branch/branch-creation-text-box.png deleted file mode 100644 index f95a7942b11a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/branch/branch-creation-text-box.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/branch/branch-selection-dropdown.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/branch/branch-selection-dropdown.png deleted file mode 100644 index 4e0bde97367f..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/branch/branch-selection-dropdown.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/branches/branches-link.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/branches/branches-link.png deleted file mode 100644 index dda96dadb20f..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/branches/branches-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/branches/branches-overview-atom.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/branches/branches-overview-atom.png deleted file mode 100644 index 9c3e7dd79167..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/branches/branches-overview-atom.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/business-accounts/billing-license-info.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/business-accounts/billing-license-info.png deleted file mode 100644 index bd5e610ecefd..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/business-accounts/billing-license-info.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png deleted file mode 100644 index 3c33270e8571..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/business-accounts/enterprise-account-settings-security-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png deleted file mode 100644 index b4081b262e4e..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/codespaces/click-remote-explorer-icon-vscode.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/commits/Commit-master-label.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/commits/Commit-master-label.png deleted file mode 100644 index 1b0bd0322068..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/commits/Commit-master-label.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/notifications-v2/dependabot-alerts-options.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/notifications-v2/dependabot-alerts-options.png deleted file mode 100644 index 0d8bc26f96b4..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/notifications-v2/dependabot-alerts-options.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/organizations/org-settings-member-privileges.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/organizations/org-settings-member-privileges.png deleted file mode 100644 index bfd09369ebcd..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/organizations/org-settings-member-privileges.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/organizations/repo-labels-tab.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/organizations/repo-labels-tab.png deleted file mode 100644 index df9402d85515..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/organizations/repo-labels-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/profile/profile-block-or-report-button.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/profile/profile-block-or-report-button.png deleted file mode 100644 index a4adf3ee72d5..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/profile/profile-block-or-report-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/projects/team-discussions-comment-button.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/projects/team-discussions-comment-button.png deleted file mode 100644 index e625d210cb12..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/projects/team-discussions-comment-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/projects/team-discussions-comment.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/projects/team-discussions-comment.png deleted file mode 100644 index bf40d3a62f6a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/projects/team-discussions-comment.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/projects/team-discussions-privacy-menu.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/projects/team-discussions-privacy-menu.png deleted file mode 100644 index e1e2b184043c..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/projects/team-discussions-privacy-menu.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/branch-dropdown.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/branch-dropdown.png deleted file mode 100644 index 7ba69b1f1ddf..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/branch-dropdown.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/choose-base-and-compare-branches.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/choose-base-and-compare-branches.png deleted file mode 100644 index c9ffd3f1b0cb..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/choose-base-and-compare-branches.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/choose-base-fork-and-branch.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/choose-base-fork-and-branch.png deleted file mode 100644 index 451035484703..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/choose-base-fork-and-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/choose-head-fork-compare-branch.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/choose-head-fork-compare-branch.png deleted file mode 100644 index 1db5fe09a6f4..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/choose-head-fork-compare-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/compare-across-forks-link.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/compare-across-forks-link.png deleted file mode 100644 index 6676a282cbe1..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/compare-across-forks-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/compare-branch-example.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/compare-branch-example.png deleted file mode 100644 index b3831912b2e6..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/compare-branch-example.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/pull-request-edit-base-branch.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/pull-request-edit-base-branch.png deleted file mode 100644 index 9e87a5dc4dec..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/pull-request-edit-base-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/pull-request-edit.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/pull-request-edit.png deleted file mode 100644 index bd05b7b0e62a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/pull-request-edit.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/pull-request-review-edit-branch.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/pull-request-review-edit-branch.png deleted file mode 100644 index 0382a63fcfe6..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/pull-request-review-edit-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/revert-pull-request-link.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/revert-pull-request-link.png deleted file mode 100644 index 57e7fdade011..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/pull_requests/revert-pull-request-link.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/releases/releases-tag-branch.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/releases/releases-tag-branch.png deleted file mode 100644 index ff613680dfd0..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/releases/releases-tag-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/releases/releases-tag-version.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/releases/releases-tag-version.png deleted file mode 100644 index 693573cd5523..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/releases/releases-tag-version.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/actions-delete-artifact.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/actions-delete-artifact.png deleted file mode 100644 index 62322ba6a659..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/actions-delete-artifact.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/artifact-drop-down.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/artifact-drop-down.png deleted file mode 100644 index d045551cbd7f..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/artifact-drop-down.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-alert-close-drop-down.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-alert-close-drop-down.png deleted file mode 100644 index ccf03f8f1e8e..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-alert-close-drop-down.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-alert.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-alert.png deleted file mode 100644 index 437ef4af997e..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-alert.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-click-alert.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-click-alert.png deleted file mode 100644 index f1ea07b843d2..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-click-alert.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-pr-alert.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-pr-alert.png deleted file mode 100644 index ef13d6a66b54..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-pr-alert.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-pr-annotation.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-pr-annotation.png deleted file mode 100644 index f71a65cebd08..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-pr-annotation.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-set-up-this-workflow.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-set-up-this-workflow.png deleted file mode 100644 index 8875fdbae3aa..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-set-up-this-workflow.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-show-paths.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-show-paths.png deleted file mode 100644 index c2e69d8fc46b..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/code-scanning-show-paths.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/create-commit-open-readme.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/create-commit-open-readme.png deleted file mode 100644 index bf622bcbd849..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/create-commit-open-readme.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/delete-all-logs.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/delete-all-logs.png deleted file mode 100644 index d4570352b861..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/delete-all-logs.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/dependency-graph-enable-button.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/dependency-graph-enable-button.png deleted file mode 100644 index e9e059df9588..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/dependency-graph-enable-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/download-logs-drop-down.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/download-logs-drop-down.png deleted file mode 100644 index 19919eb2f830..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/download-logs-drop-down.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/include-all-branches.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/include-all-branches.png deleted file mode 100644 index 4d81d46872a6..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/include-all-branches.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/issue-template-commit-message-field.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/issue-template-commit-message-field.png deleted file mode 100644 index 55121147dc5d..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/issue-template-commit-message-field.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/issue-template-commit-to-master-or-open-pull-request.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/issue-template-commit-to-master-or-open-pull-request.png deleted file mode 100644 index a234ab3480b4..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/issue-template-commit-to-master-or-open-pull-request.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/propose-file-change-quick-pull.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/propose-file-change-quick-pull.png deleted file mode 100644 index e0f91e56dd6a..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/propose-file-change-quick-pull.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/repo-with-readme.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/repo-with-readme.png deleted file mode 100644 index 89594e645ef0..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/repo-with-readme.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/repository-options-branch.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/repository-options-branch.png deleted file mode 100644 index fdf36c69c04f..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/repository-options-branch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/repository-options-defaultbranch.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/repository-options-defaultbranch.png deleted file mode 100644 index d45e6ee8caec..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/repository-options-defaultbranch.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/run-name.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/run-name.png deleted file mode 100644 index bf8988b4aecc..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/run-name.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/username-repo-with-readme.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/username-repo-with-readme.png deleted file mode 100644 index f518b6d41f30..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/username-repo-with-readme.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/workflow-sidebar.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/workflow-sidebar.png deleted file mode 100644 index 1c0597f14920..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/workflow-sidebar.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/write-commit-message-co-author-trailer.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/write-commit-message-co-author-trailer.png deleted file mode 100644 index 92aebb55dbe7..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/repository/write-commit-message-co-author-trailer.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png deleted file mode 100644 index b61b6207a965..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/actions-org-add-runner-group-options.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/actions-org-add-runner-group-options.png deleted file mode 100644 index a06d0354fb8f..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/actions-org-add-runner-group-options.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/audit-log-tab.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/audit-log-tab.png deleted file mode 100644 index c310a8b68deb..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/audit-log-tab.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/settings-sidebar-account-settings.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/settings-sidebar-account-settings.png deleted file mode 100644 index cf8a7402e9e7..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/settings-sidebar-account-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/settings-sidebar-ssh-keys.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/settings-sidebar-ssh-keys.png deleted file mode 100644 index c48d203519c3..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/settings-sidebar-ssh-keys.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/settings-ssh-key-review.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/settings-ssh-key-review.png deleted file mode 100644 index 992d1307784b..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/settings-ssh-key-review.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/userbar-account-settings.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/userbar-account-settings.png deleted file mode 100644 index f54ce518cd26..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/settings/userbar-account-settings.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/setup/keychain-access.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/setup/keychain-access.png deleted file mode 100644 index 7628dd83b492..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/setup/keychain-access.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/2.22/assets/images/help/sponsors/manage-your-sponsorship-button.png b/assets/images/enterprise/legacy-format/2.22/assets/images/help/sponsors/manage-your-sponsorship-button.png deleted file mode 100644 index 3c094ea2fcf4..000000000000 Binary files a/assets/images/enterprise/legacy-format/2.22/assets/images/help/sponsors/manage-your-sponsorship-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/management-console/code-scanning-disable.png b/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/management-console/code-scanning-disable.png deleted file mode 100644 index 3b5fbd47c959..000000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/management-console/code-scanning-disable.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/management-console/enable-code-scanning-checkbox.png b/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/management-console/enable-code-scanning-checkbox.png deleted file mode 100644 index 396a52387f2c..000000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/management-console/enable-code-scanning-checkbox.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/management-console/sidebar-advanced-security.png b/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/management-console/sidebar-advanced-security.png deleted file mode 100644 index dc1097dae202..000000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/management-console/sidebar-advanced-security.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/add-announcement-button.png b/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/add-announcement-button.png deleted file mode 100644 index 1a8822138d28..000000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/add-announcement-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/edit-message.png b/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/edit-message.png deleted file mode 100644 index d7a61a45622a..000000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/edit-message.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png b/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png deleted file mode 100644 index 1dd271ada478..000000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/sign-out-add-message-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/suspend.png b/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/suspend.png deleted file mode 100644 index 433cbf69cd1e..000000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/enterprise/site-admin-settings/suspend.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/help/business-accounts/billing-license-info.png b/assets/images/enterprise/legacy-format/3.0/assets/images/help/business-accounts/billing-license-info.png deleted file mode 100644 index 9339722b3bbf..000000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/help/business-accounts/billing-license-info.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/code-scanning-click-alert.png b/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/code-scanning-click-alert.png deleted file mode 100644 index aeddd97f3213..000000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/code-scanning-click-alert.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/code-scanning-set-up-this-workflow.png b/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/code-scanning-set-up-this-workflow.png deleted file mode 100644 index 8ad80d52af33..000000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/code-scanning-set-up-this-workflow.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/dependency-graph-enable-button.png b/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/dependency-graph-enable-button.png deleted file mode 100644 index 813b0ada5afc..000000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/dependency-graph-enable-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/secret-scanning-click-alert.png b/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/secret-scanning-click-alert.png deleted file mode 100644 index f3f57f311fca..000000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/secret-scanning-click-alert.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/secret-scanning-resolve-alert.png b/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/secret-scanning-resolve-alert.png deleted file mode 100644 index 3454284124a2..000000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/help/repository/secret-scanning-resolve-alert.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/3.0/assets/images/help/sponsors/manage-your-sponsorship-button.png b/assets/images/enterprise/legacy-format/3.0/assets/images/help/sponsors/manage-your-sponsorship-button.png deleted file mode 100644 index 3c094ea2fcf4..000000000000 Binary files a/assets/images/enterprise/legacy-format/3.0/assets/images/help/sponsors/manage-your-sponsorship-button.png and /dev/null differ diff --git a/assets/images/enterprise/legacy-format/README.md b/assets/images/enterprise/legacy-format/README.md deleted file mode 100644 index 7205e99284b8..000000000000 --- a/assets/images/enterprise/legacy-format/README.md +++ /dev/null @@ -1,7 +0,0 @@ -### Legacy assets - -**Do not add new images to this directory.** This directory will be removed after GHES 3.0 is deprecated. - -This directory stores images that were migrated to this repository from AWS S3. These images are not referenced directly in Markdown content. Images in this directory are rendered conditionally using a Unified.js plugin located at [`lib/render-content/plugins/rewite-legacy-asset-paths.js`](lib/render-content/plugins/rewite-legacy-asset-paths.js). When a page is rendered, the plugin checks whether the image referenced in the Markdown content (e.g., /assets/images/foo/bar.png) has a corresponding image in this directory for the version being rendered (e.g., /assets/images/enterprise/legacy-format//assets/images/foo/bar.png. If a corresponding image does exist in the `legacy-format` directory, the image from the `legacy-format` directory is rendered. If not, the image path referenced in the Markdown is used (e.g., /assets/images/foo/bar.png). - -This directory and the `rewrite-legacy-asset-paths` plugin will be removed when GHES 3.0 is deprecated in favor of single-sourcing the images referenced in Markdown, which requires versioning the images in the Markdown content using Liquid conditionals. \ No newline at end of file diff --git a/assets/images/enterprise/migration/restore-complete-screen.png b/assets/images/enterprise/migration/restore-complete-screen.png deleted file mode 100644 index 62105dadad91..000000000000 Binary files a/assets/images/enterprise/migration/restore-complete-screen.png and /dev/null differ diff --git a/assets/images/github-apps/github_apps_content_reference_attachment.png b/assets/images/github-apps/content_reference_attachment.png similarity index 100% rename from assets/images/github-apps/github_apps_content_reference_attachment.png rename to assets/images/github-apps/content_reference_attachment.png diff --git a/assets/images/help/apps/github_apps_app_name.png b/assets/images/help/apps/github_apps_app_name.png deleted file mode 100644 index 8110688432b6..000000000000 Binary files a/assets/images/help/apps/github_apps_app_name.png and /dev/null differ diff --git a/assets/images/help/apps/github_apps_create_github_app.png b/assets/images/help/apps/github_apps_create_github_app.png deleted file mode 100644 index f828cdaf0c24..000000000000 Binary files a/assets/images/help/apps/github_apps_create_github_app.png and /dev/null differ diff --git a/assets/images/help/apps/github_apps_homepage_url.png b/assets/images/help/apps/github_apps_homepage_url.png deleted file mode 100644 index f5b321725cf3..000000000000 Binary files a/assets/images/help/apps/github_apps_homepage_url.png and /dev/null differ diff --git a/assets/images/help/apps/github_apps_new.png b/assets/images/help/apps/github_apps_new.png deleted file mode 100644 index fb86904b8e19..000000000000 Binary files a/assets/images/help/apps/github_apps_new.png and /dev/null differ diff --git a/assets/images/help/apps/github_apps_user_authorization.png b/assets/images/help/apps/github_apps_user_authorization.png deleted file mode 100644 index 31c8644bdb05..000000000000 Binary files a/assets/images/help/apps/github_apps_user_authorization.png and /dev/null differ diff --git a/assets/images/help/apps/github_apps_webhook_secret.png b/assets/images/help/apps/github_apps_webhook_secret.png deleted file mode 100644 index b1626fbaa772..000000000000 Binary files a/assets/images/help/apps/github_apps_webhook_secret.png and /dev/null differ diff --git a/assets/images/help/apps/github_apps_webhook_url.png b/assets/images/help/apps/github_apps_webhook_url.png deleted file mode 100644 index cf9e1607e016..000000000000 Binary files a/assets/images/help/apps/github_apps_webhook_url.png and /dev/null differ diff --git a/assets/images/help/desktop/click-branch-in-drop-down-mac.png b/assets/images/help/desktop/click-branch-in-drop-down-mac.png index 54deda6f2318..2099567450a1 100644 Binary files a/assets/images/help/desktop/click-branch-in-drop-down-mac.png and b/assets/images/help/desktop/click-branch-in-drop-down-mac.png differ diff --git a/assets/images/help/desktop/click-branch-in-drop-down.png b/assets/images/help/desktop/click-branch-in-drop-down.png deleted file mode 100644 index 2099567450a1..000000000000 Binary files a/assets/images/help/desktop/click-branch-in-drop-down.png and /dev/null differ diff --git a/assets/images/help/desktop/mac-changed-file-header.png b/assets/images/help/desktop/mac-changed-file-header.png new file mode 100644 index 000000000000..064f82597392 Binary files /dev/null and b/assets/images/help/desktop/mac-changed-file-header.png differ diff --git a/assets/images/help/desktop/mac-discard-stashed-changes-button.png b/assets/images/help/desktop/mac-discard-stashed-changes-button.png new file mode 100644 index 000000000000..be1631765ef5 Binary files /dev/null and b/assets/images/help/desktop/mac-discard-stashed-changes-button.png differ diff --git a/assets/images/help/desktop/mac-restore-stashed-changes-button.png b/assets/images/help/desktop/mac-restore-stashed-changes-button.png new file mode 100644 index 000000000000..1a0ae797d6d0 Binary files /dev/null and b/assets/images/help/desktop/mac-restore-stashed-changes-button.png differ diff --git a/assets/images/help/desktop/mac-stash-all-changes.png b/assets/images/help/desktop/mac-stash-all-changes.png new file mode 100644 index 000000000000..454f631f419b Binary files /dev/null and b/assets/images/help/desktop/mac-stash-all-changes.png differ diff --git a/assets/images/help/desktop/mac-sign-in-browser.png b/assets/images/help/desktop/sign-in-browser.png similarity index 100% rename from assets/images/help/desktop/mac-sign-in-browser.png rename to assets/images/help/desktop/sign-in-browser.png diff --git a/assets/images/help/desktop/windows-changed-file-header.png b/assets/images/help/desktop/windows-changed-file-header.png new file mode 100644 index 000000000000..e1051eacd869 Binary files /dev/null and b/assets/images/help/desktop/windows-changed-file-header.png differ diff --git a/assets/images/help/desktop/windows-discard-stashed-changes-button.png b/assets/images/help/desktop/windows-discard-stashed-changes-button.png new file mode 100644 index 000000000000..5437acfea7bf Binary files /dev/null and b/assets/images/help/desktop/windows-discard-stashed-changes-button.png differ diff --git a/assets/images/help/desktop/windows-restore-stashed-changes-button.png b/assets/images/help/desktop/windows-restore-stashed-changes-button.png new file mode 100644 index 000000000000..289d2f420f3a Binary files /dev/null and b/assets/images/help/desktop/windows-restore-stashed-changes-button.png differ diff --git a/assets/images/help/desktop/windows-sign-in-browser.png b/assets/images/help/desktop/windows-sign-in-browser.png deleted file mode 100644 index 20e28f8081dd..000000000000 Binary files a/assets/images/help/desktop/windows-sign-in-browser.png and /dev/null differ diff --git a/assets/images/help/desktop/windows-stash-all-changes.png b/assets/images/help/desktop/windows-stash-all-changes.png new file mode 100644 index 000000000000..2bf3afad8d50 Binary files /dev/null and b/assets/images/help/desktop/windows-stash-all-changes.png differ diff --git a/assets/images/help/issues/issues_assignee_dropdown.png b/assets/images/help/issues/issues_assignee_dropdown.png index 36b54dccaa68..f4b4d7f6b521 100644 Binary files a/assets/images/help/issues/issues_assignee_dropdown.png and b/assets/images/help/issues/issues_assignee_dropdown.png differ diff --git a/assets/images/help/issues/issues_assigning_dropdown.png b/assets/images/help/issues/issues_assigning_dropdown.png index d16bd1b9e9c7..cd1742ae77e6 100644 Binary files a/assets/images/help/issues/issues_assigning_dropdown.png and b/assets/images/help/issues/issues_assigning_dropdown.png differ diff --git a/assets/images/help/organizations/dependabot-private-repo-choose.png b/assets/images/help/organizations/dependabot-private-repo-choose.png new file mode 100644 index 000000000000..78774eeeb277 Binary files /dev/null and b/assets/images/help/organizations/dependabot-private-repo-choose.png differ diff --git a/assets/images/help/organizations/dependabot-private-repository-access.png b/assets/images/help/organizations/dependabot-private-repository-access.png new file mode 100644 index 000000000000..1d2e622bca08 Binary files /dev/null and b/assets/images/help/organizations/dependabot-private-repository-access.png differ diff --git a/assets/images/help/organizations/dependabot-private-repository-list.png b/assets/images/help/organizations/dependabot-private-repository-list.png new file mode 100644 index 000000000000..e1af56613043 Binary files /dev/null and b/assets/images/help/organizations/dependabot-private-repository-list.png differ diff --git a/assets/images/help/organizations/org-invite-modal-ghe.png b/assets/images/help/organizations/org-invite-modal-ghe.png deleted file mode 100644 index 2bd6fcefcad7..000000000000 Binary files a/assets/images/help/organizations/org-invite-modal-ghe.png and /dev/null differ diff --git a/assets/images/help/organizations/org-settings-security-tab.png b/assets/images/help/organizations/org-settings-security-tab.png deleted file mode 100644 index 64c8a259b08b..000000000000 Binary files a/assets/images/help/organizations/org-settings-security-tab.png and /dev/null differ diff --git a/assets/images/help/organizations/repositories-dialog.png b/assets/images/help/organizations/repositories-dialog.png deleted file mode 100644 index 7743ed2e6b7b..000000000000 Binary files a/assets/images/help/organizations/repositories-dialog.png and /dev/null differ diff --git a/assets/images/help/organizations/repository-access-cog-button.png b/assets/images/help/organizations/repository-access-cog-button.png deleted file mode 100644 index 94cab6198c9d..000000000000 Binary files a/assets/images/help/organizations/repository-access-cog-button.png and /dev/null differ diff --git a/assets/images/help/organizations/security-and-analysis-highlight-ghas.png b/assets/images/help/organizations/security-and-analysis-highlight-ghas.png deleted file mode 100644 index cd4856c503c5..000000000000 Binary files a/assets/images/help/organizations/security-and-analysis-highlight-ghas.png and /dev/null differ diff --git a/assets/images/help/package-registry/make-all-container-versions-visible.png b/assets/images/help/package-registry/make-all-container-versions-visible.png deleted file mode 100644 index 29a7e88a40f5..000000000000 Binary files a/assets/images/help/package-registry/make-all-container-versions-visible.png and /dev/null differ diff --git a/assets/images/help/pages/gemfile-instructions.png b/assets/images/help/pages/gemfile-instructions.png deleted file mode 100644 index d7e110509790..000000000000 Binary files a/assets/images/help/pages/gemfile-instructions.png and /dev/null differ diff --git a/assets/images/help/repository/sidebar-code-scanning-alerts.png b/assets/images/help/repository/sidebar-code-scanning-alerts.png index 1703205b5b5e..6dab36ebf60f 100644 Binary files a/assets/images/help/repository/sidebar-code-scanning-alerts.png and b/assets/images/help/repository/sidebar-code-scanning-alerts.png differ diff --git a/assets/images/help/repository/sidebar-secrets.png b/assets/images/help/repository/sidebar-secrets.png index b92c4537b9d8..4053a570652a 100644 Binary files a/assets/images/help/repository/sidebar-secrets.png and b/assets/images/help/repository/sidebar-secrets.png differ diff --git a/assets/images/help/security/ip-address-delete-button.png b/assets/images/help/security/ip-address-delete-button.png index a1dc64631af3..9f0508910b5b 100644 Binary files a/assets/images/help/security/ip-address-delete-button.png and b/assets/images/help/security/ip-address-delete-button.png differ diff --git a/assets/images/help/security/ip-address-edit-button.png b/assets/images/help/security/ip-address-edit-button.png index 206d6a74c2ae..46718c2b2044 100644 Binary files a/assets/images/help/security/ip-address-edit-button.png and b/assets/images/help/security/ip-address-edit-button.png differ diff --git a/assets/images/help/security/ip-address-edit-field.png b/assets/images/help/security/ip-address-edit-field.png index b2e7d4540c44..88fcf76614f3 100644 Binary files a/assets/images/help/security/ip-address-edit-field.png and b/assets/images/help/security/ip-address-edit-field.png differ diff --git a/assets/images/help/security/ip-address-edit-name-field.png b/assets/images/help/security/ip-address-edit-name-field.png index c2e4935986b3..e3586a195490 100644 Binary files a/assets/images/help/security/ip-address-edit-name-field.png and b/assets/images/help/security/ip-address-edit-name-field.png differ diff --git a/assets/images/help/security/ip-address-field.png b/assets/images/help/security/ip-address-field.png index 2dee7c887173..0b5d8379371d 100644 Binary files a/assets/images/help/security/ip-address-field.png and b/assets/images/help/security/ip-address-field.png differ diff --git a/assets/images/help/security/ip-address-name-field.png b/assets/images/help/security/ip-address-name-field.png index 98ad82a08d30..1937af4bcc27 100644 Binary files a/assets/images/help/security/ip-address-name-field.png and b/assets/images/help/security/ip-address-name-field.png differ diff --git a/assets/images/help/security/new-allowlist-entry-button.png b/assets/images/help/security/new-allowlist-entry-button.png index 67a7f7336cf2..639ddbd2afb1 100644 Binary files a/assets/images/help/security/new-allowlist-entry-button.png and b/assets/images/help/security/new-allowlist-entry-button.png differ diff --git a/assets/images/help/security/overview-set-up-code-scanning.png b/assets/images/help/security/overview-set-up-code-scanning.png index 604380502fc6..8743911b2992 100644 Binary files a/assets/images/help/security/overview-set-up-code-scanning.png and b/assets/images/help/security/overview-set-up-code-scanning.png differ diff --git a/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png b/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png index 8c8d2b8b914b..2ad8cbc63007 100644 Binary files a/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png and b/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png differ diff --git a/assets/images/help/settings/actions-enterprise-policies.png b/assets/images/help/settings/actions-enterprise-policies.png new file mode 100644 index 000000000000..b53045e0f07a Binary files /dev/null and b/assets/images/help/settings/actions-enterprise-policies.png differ diff --git a/assets/images/help/settings/actions-hosted-runner-add-new-group.png b/assets/images/help/settings/actions-hosted-runner-add-new-group.png new file mode 100644 index 000000000000..1fa8f059ea25 Binary files /dev/null and b/assets/images/help/settings/actions-hosted-runner-add-new-group.png differ diff --git a/assets/images/help/settings/actions-hosted-runner-group-kebab.png b/assets/images/help/settings/actions-hosted-runner-group-kebab.png new file mode 100644 index 000000000000..fb805f6fb338 Binary files /dev/null and b/assets/images/help/settings/actions-hosted-runner-group-kebab.png differ diff --git a/assets/images/help/settings/actions-hosted-runner-group-member-move-destination.png b/assets/images/help/settings/actions-hosted-runner-group-member-move-destination.png new file mode 100644 index 000000000000..5380086c5b6e Binary files /dev/null and b/assets/images/help/settings/actions-hosted-runner-group-member-move-destination.png differ diff --git a/assets/images/help/settings/actions-hosted-runner-group-member-move.png b/assets/images/help/settings/actions-hosted-runner-group-member-move.png new file mode 100644 index 000000000000..e698056a7ced Binary files /dev/null and b/assets/images/help/settings/actions-hosted-runner-group-member-move.png differ diff --git a/assets/images/help/settings/actions-hosted-runner-group-members.png b/assets/images/help/settings/actions-hosted-runner-group-members.png new file mode 100644 index 000000000000..72acf1201aea Binary files /dev/null and b/assets/images/help/settings/actions-hosted-runner-group-members.png differ diff --git a/assets/images/help/settings/actions-hosted-runner-group-remove.png b/assets/images/help/settings/actions-hosted-runner-group-remove.png new file mode 100644 index 000000000000..eea19694b906 Binary files /dev/null and b/assets/images/help/settings/actions-hosted-runner-group-remove.png differ diff --git a/assets/images/help/settings/actions-hosted-runner-list-label.png b/assets/images/help/settings/actions-hosted-runner-list-label.png new file mode 100644 index 000000000000..c0705c7b34ce Binary files /dev/null and b/assets/images/help/settings/actions-hosted-runner-list-label.png differ diff --git a/assets/images/help/settings/actions-org-add-runner-group-options.png b/assets/images/help/settings/actions-org-add-runner-group-options.png index f68e357a60b6..e81f26dbd720 100644 Binary files a/assets/images/help/settings/actions-org-add-runner-group-options.png and b/assets/images/help/settings/actions-org-add-runner-group-options.png differ diff --git a/assets/images/help/settings/settings-sidebar-actions.png b/assets/images/help/settings/settings-sidebar-actions.png index 8fa42ac0680d..99fe42b0cf34 100644 Binary files a/assets/images/help/settings/settings-sidebar-actions.png and b/assets/images/help/settings/settings-sidebar-actions.png differ diff --git a/assets/images/help/writing/content-attachment.png b/assets/images/help/writing/content-attachment.png deleted file mode 100644 index 0d530dd933b5..000000000000 Binary files a/assets/images/help/writing/content-attachment.png and /dev/null differ diff --git a/assets/images/settings/oauth_apps_post2dot12.png b/assets/images/settings/oauth_apps_post2dot12.png deleted file mode 100644 index 23b2d9002979..000000000000 Binary files a/assets/images/settings/oauth_apps_post2dot12.png and /dev/null differ diff --git a/content/actions/creating-actions/about-actions.md b/content/actions/creating-actions/about-actions.md index 4c9b2e16eaa9..d3cd0448b465 100644 --- a/content/actions/creating-actions/about-actions.md +++ b/content/actions/creating-actions/about-actions.md @@ -10,6 +10,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'overview' topics: - 'Action development' @@ -18,6 +19,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About actions @@ -125,7 +127,7 @@ steps: #### Using a commit's SHA for release management -Each Git commit receives a calculated SHA value, which is unique and immutable. Your action's users might prefer to rely on a commit's SHA value, as this approach can be more reliable than specifying a tag, which could be deleted or moved. However, this means that users will not receive further updates made to the action. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}You must use a commit's full SHA value, and not an abbreviated value.{% else %}Using a commit's full SHA value instead of the abbreviated value can help prevent people from using a malicious commit that uses the same abbreviation.{% endif %} +Each Git commit receives a calculated SHA value, which is unique and immutable. Your action's users might prefer to rely on a commit's SHA value, as this approach can be more reliable than specifying a tag, which could be deleted or moved. However, this means that users will not receive further updates made to the action. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}You must use a commit's full SHA value, and not an abbreviated value.{% else %}Using a commit's full SHA value instead of the abbreviated value can help prevent people from using a malicious commit that uses the same abbreviation.{% endif %} ```yaml steps: diff --git a/content/actions/creating-actions/creating-a-composite-run-steps-action.md b/content/actions/creating-actions/creating-a-composite-run-steps-action.md index efd8430a3c2e..52b38993e92a 100644 --- a/content/actions/creating-actions/creating-a-composite-run-steps-action.md +++ b/content/actions/creating-actions/creating-a-composite-run-steps-action.md @@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Action development' @@ -12,6 +13,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/creating-actions/creating-a-docker-container-action.md b/content/actions/creating-actions/creating-a-docker-container-action.md index 33fa426b4b90..844766f6cbbb 100644 --- a/content/actions/creating-actions/creating-a-docker-container-action.md +++ b/content/actions/creating-actions/creating-a-docker-container-action.md @@ -10,6 +10,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Action development' @@ -18,6 +19,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction @@ -32,9 +34,13 @@ Once you complete this project, you should understand how to build your own Dock You may find it helpful to have a basic understanding of {% data variables.product.prodname_actions %} environment variables and the Docker container filesystem: - "[Using environment variables](/actions/automating-your-workflow-with-github-actions/using-environment-variables)" +{% if currentVersion == "github-ae@latest" %} +- "[Docker container filesystem](/actions/using-github-hosted-runners/about-ae-hosted-runners#docker-container-filesystem)." +{% else %} - "[Virtual environments for {% data variables.product.prodname_dotcom %}](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners#docker-container-filesystem)" +{% endif %} -Before you begin, you'll need to create a GitHub repository. +Before you begin, you'll need to create a {% data variables.product.prodname_dotcom %} repository. 1. Create a new repository on {% data variables.product.product_location %}. You can choose any repository name or use "hello-world-docker-action" like this example. For more information, see "[Create a new repository](/articles/creating-a-new-repository)." @@ -229,9 +235,9 @@ jobs: ``` {% endraw %} -From your repository, click the **Actions** tab, and select the latest workflow run. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log. +From your repository, click the **Actions** tab, and select the latest workflow run. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![A screenshot of using your action in a workflow](/assets/images/help/repository/docker-action-workflow-run-updated.png) {% else %} ![A screenshot of using your action in a workflow](/assets/images/help/repository/docker-action-workflow-run.png) diff --git a/content/actions/creating-actions/creating-a-javascript-action.md b/content/actions/creating-actions/creating-a-javascript-action.md index 0068ed60a501..960241781f8e 100644 --- a/content/actions/creating-actions/creating-a-javascript-action.md +++ b/content/actions/creating-actions/creating-a-javascript-action.md @@ -10,6 +10,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Action development' @@ -18,6 +19,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction @@ -265,9 +267,9 @@ jobs: ``` {% endraw %} -From your repository, click the **Actions** tab, and select the latest workflow run. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log. +From your repository, click the **Actions** tab, and select the latest workflow run. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}Under **Jobs** or in the visualization graph, click **A job to say hello**. {% endif %}You should see "Hello Mona the Octocat" or the name you used for the `who-to-greet` input and the timestamp printed in the log. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run-updated-2.png) {% elsif currentVersion ver_gt "enterprise-server@2.22" %} ![A screenshot of using your action in a workflow](/assets/images/help/repository/javascript-action-workflow-run-updated.png) diff --git a/content/actions/creating-actions/dockerfile-support-for-github-actions.md b/content/actions/creating-actions/dockerfile-support-for-github-actions.md index dba9c8dd1ed4..5fa52db771c8 100644 --- a/content/actions/creating-actions/dockerfile-support-for-github-actions.md +++ b/content/actions/creating-actions/dockerfile-support-for-github-actions.md @@ -8,11 +8,13 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'reference' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About Dockerfile instructions diff --git a/content/actions/creating-actions/index.md b/content/actions/creating-actions/index.md index 966e98032bd1..69567c437806 100644 --- a/content/actions/creating-actions/index.md +++ b/content/actions/creating-actions/index.md @@ -10,10 +10,12 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} {% link_in_list /about-actions %} {% link_in_list /creating-a-docker-container-action %} diff --git a/content/actions/creating-actions/metadata-syntax-for-github-actions.md b/content/actions/creating-actions/metadata-syntax-for-github-actions.md index 4dfb33bcf807..1052bd4b7655 100644 --- a/content/actions/creating-actions/metadata-syntax-for-github-actions.md +++ b/content/actions/creating-actions/metadata-syntax-for-github-actions.md @@ -11,11 +11,13 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'reference' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About YAML syntax for {% data variables.product.prodname_actions %} @@ -247,7 +249,7 @@ For more information, see "[`github context`](/actions/reference/context-and-exp ##### `runs.steps[*].env` -**Optional** Sets a `map` of environment variables for only that step. If you want to modify the environment variable stored in the workflow, use {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}`echo "{name}={value}" >> $GITHUB_ENV`{% else %}`echo "::set-env name={name}::{value}"`{% endif %} in a composite run step. +**Optional** Sets a `map` of environment variables for only that step. If you want to modify the environment variable stored in the workflow, use {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}`echo "{name}={value}" >> $GITHUB_ENV`{% else %}`echo "::set-env name={name}::{value}"`{% endif %} in a composite run step. ##### `runs.steps[*].working-directory` @@ -297,7 +299,7 @@ runs: #### `runs.image` -**Required** The Docker image to use as the container to run the action. The value can be the Docker base image name, a local `Dockerfile` in your repository, or a public image in Docker Hub or another registry. To reference a `Dockerfile` local to your repository, use a path relative to your action metadata file. The `docker` application will execute this file. +**Required** The Docker image to use as the container to run the action. The value can be the Docker base image name, a local `Dockerfile` in your repository, or a public image in Docker Hub or another registry. To reference a `Dockerfile` local to your repository, the file must be named `Dockerfile` and you must use a path relative to your action metadata file. The `docker` application will execute this file. #### `runs.env` diff --git a/content/actions/creating-actions/publishing-actions-in-github-marketplace.md b/content/actions/creating-actions/publishing-actions-in-github-marketplace.md index b69b89065b7d..564cc0453165 100644 --- a/content/actions/creating-actions/publishing-actions-in-github-marketplace.md +++ b/content/actions/creating-actions/publishing-actions-in-github-marketplace.md @@ -11,6 +11,8 @@ versions: type: 'how_to' --- +{% data reusables.actions.ae-beta %} + You must accept the terms of service to publish actions in {% data variables.product.prodname_marketplace %}. ### About publishing actions diff --git a/content/actions/creating-actions/setting-exit-codes-for-actions.md b/content/actions/creating-actions/setting-exit-codes-for-actions.md index 2a733849d5c0..5a65cac3008e 100644 --- a/content/actions/creating-actions/setting-exit-codes-for-actions.md +++ b/content/actions/creating-actions/setting-exit-codes-for-actions.md @@ -8,11 +8,13 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'how_to' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About exit codes diff --git a/content/actions/guides/about-continuous-integration.md b/content/actions/guides/about-continuous-integration.md index c85d6cd06bca..a249137af6d8 100644 --- a/content/actions/guides/about-continuous-integration.md +++ b/content/actions/guides/about-continuous-integration.md @@ -10,6 +10,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'overview' topics: - 'CI' @@ -18,6 +19,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About continuous integration @@ -29,7 +31,9 @@ Building and testing your code requires a server. You can build and test updates ### About continuous integration using {% data variables.product.prodname_actions %} -CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on {% data variables.product.prodname_dotcom %}-hosted virtual machines, or on machines that you host yourself. For more information, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)" and "[About self-hosted runners](/actions/automating-your-workflow-with-github-actions/about-self-hosted-runners)." +{% if currentVersion == "github-ae@latest" %}CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on virtual machines hosted by {% data variables.product.prodname_dotcom %}. For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)." +{% else %} CI using {% data variables.product.prodname_actions %} offers workflows that can build the code in your repository and run your tests. Workflows can run on {% data variables.product.prodname_dotcom %}-hosted virtual machines, or on machines that you host yourself. For more information, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)" and "[About self-hosted runners](/actions/automating-your-workflow-with-github-actions/about-self-hosted-runners)." +{% endif %} You can configure your CI workflow to run when a {% data variables.product.product_name %} event occurs (for example, when new code is pushed to your repository), on a set schedule, or when an external event occurs using the repository dispatch webhook. diff --git a/content/actions/guides/about-packaging-with-github-actions.md b/content/actions/guides/about-packaging-with-github-actions.md index 77fbd944bd90..0b3d9fb5160a 100644 --- a/content/actions/guides/about-packaging-with-github-actions.md +++ b/content/actions/guides/about-packaging-with-github-actions.md @@ -8,6 +8,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'overview' topics: - 'Packaging' @@ -15,6 +16,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About packaging steps @@ -28,7 +30,7 @@ Creating a package at the end of a continuous integration workflow can help duri Now, when reviewing a pull request, you'll be able to look at the workflow run and download the artifact that was produced. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down-updated.png) {% else %} ![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down.png) diff --git a/content/actions/guides/about-service-containers.md b/content/actions/guides/about-service-containers.md index 5c5172fd926e..ae58afd85d35 100644 --- a/content/actions/guides/about-service-containers.md +++ b/content/actions/guides/about-service-containers.md @@ -8,6 +8,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'overview' topics: - 'Containers' @@ -16,6 +17,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About service containers diff --git a/content/actions/guides/building-and-testing-java-with-ant.md b/content/actions/guides/building-and-testing-java-with-ant.md index 4fa691d5783e..e11803919024 100644 --- a/content/actions/guides/building-and-testing-java-with-ant.md +++ b/content/actions/guides/building-and-testing-java-with-ant.md @@ -7,6 +7,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'CI' @@ -16,12 +17,16 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction This guide shows you how to create a workflow that performs continuous integration (CI) for your Java project using the Ant build system. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that your code is always healthy. You can extend your CI workflow to upload artifacts from a workflow run. +{% if currentVersion == "github-ae@latest" %}For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Java Development Kits (JDKs) and Ant. For a list of software and the pre-installed versions for JDK and Ant, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +{% endif %} ### Prerequisites diff --git a/content/actions/guides/building-and-testing-java-with-gradle.md b/content/actions/guides/building-and-testing-java-with-gradle.md index b1349bbb213a..38ca522caf5e 100644 --- a/content/actions/guides/building-and-testing-java-with-gradle.md +++ b/content/actions/guides/building-and-testing-java-with-gradle.md @@ -7,6 +7,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'CI' @@ -16,12 +17,16 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction This guide shows you how to create a workflow that performs continuous integration (CI) for your Java project using the Gradle build system. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that your code is always healthy. You can extend your CI workflow to cache files and upload artifacts from a workflow run. +{% if currentVersion == "github-ae@latest" %}For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Java Development Kits (JDKs) and Gradle. For a list of software and the pre-installed versions for JDK and Gradle, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +{% endif %} ### Prerequisites diff --git a/content/actions/guides/building-and-testing-java-with-maven.md b/content/actions/guides/building-and-testing-java-with-maven.md index 84c68b6dae92..483caa962f2d 100644 --- a/content/actions/guides/building-and-testing-java-with-maven.md +++ b/content/actions/guides/building-and-testing-java-with-maven.md @@ -7,6 +7,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'CI' @@ -16,12 +17,16 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction This guide shows you how to create a workflow that performs continuous integration (CI) for your Java project using the Maven software project management tool. The workflow you create will allow you to see when commits to a pull request cause build or test failures against your default branch; this approach can help ensure that your code is always healthy. You can extend your CI workflow to cache files and upload artifacts from a workflow run. +{% if currentVersion == "github-ae@latest" %}For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Java Development Kits (JDKs) and Maven. For a list of software and the pre-installed versions for JDK and Maven, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +{% endif %} ### Prerequisites diff --git a/content/actions/guides/building-and-testing-net.md b/content/actions/guides/building-and-testing-net.md index 0bedcb2931d2..7d7b16173e4e 100644 --- a/content/actions/guides/building-and-testing-net.md +++ b/content/actions/guides/building-and-testing-net.md @@ -5,13 +5,20 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} + ### Introduction This guide shows you how to build, test, and publish a .NET package. -{% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with preinstalled software, which includes the .NET Core SDK. For a full list of up-to-date software and the preinstalled versions of .NET Core SDK, see [software installed on {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners). +{% if currentVersion == "github-ae@latest" %} To build and test your .NET project on {% data variables.product.prodname_ghe_managed %}, you will need to create a custom operating system image that includes the .NET Core SDK. For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with preinstalled software, which includes the .NET Core SDK. For a full list of up-to-date software and the preinstalled versions of .NET Core SDK, see [software installed on {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners). +{% endif %} ### Prerequisites @@ -42,7 +49,7 @@ jobs: steps: - uses: actions/checkout@v2 - name: Setup .NET Core SDK ${{ matrix.dotnet }} - uses: actions/setup-dotnet@v1.6.0 + uses: actions/setup-dotnet@v1.7.2 with: dotnet-version: ${{ matrix.dotnet-version }} - name: Install dependencies @@ -79,7 +86,7 @@ jobs: steps: - uses: actions/checkout@v2 - name: Setup dotnet ${{ matrix.dotnet-version }} - uses: actions/setup-dotnet@v1.6.0 + uses: actions/setup-dotnet@v1.7.2 with: dotnet-version: ${{ matrix.dotnet-version }} # You can test your matrix by printing the current dotnet version @@ -111,7 +118,7 @@ You can configure your job to use a specific version of .NET, such as `3.1.3`. A steps: - uses: actions/checkout@v2 - name: Setup dotnet - uses: actions/setup-dotnet@v1.6.0 + uses: actions/setup-dotnet@v1.7.2 with: dotnet-version: '3.1.x' - name: Install dependencies @@ -132,7 +139,7 @@ For more information, see "[Caching dependencies to speed up workflows](/actions steps: - uses: actions/checkout@v2 - name: Setup dotnet - uses: actions/setup-dotnet@v1.6.0 + uses: actions/setup-dotnet@v1.7.2 with: dotnet-version: '3.1.x' - uses: actions/cache@v2 @@ -164,7 +171,7 @@ You can use the same commands that you use locally to build and test your code. steps: - uses: actions/checkout@v2 - name: Setup dotnet - uses: actions/setup-dotnet@v1.6.0 + uses: actions/setup-dotnet@v1.7.2 with: dotnet-version: '3.1.x' - name: Install dependencies @@ -199,7 +206,7 @@ jobs: steps: - uses: actions/checkout@v2 - name: Setup dotnet - uses: actions/setup-dotnet@v1.6.0 + uses: actions/setup-dotnet@v1.7.2 with: dotnet-version: ${{ matrix.dotnet-version }} - name: Install dependencies diff --git a/content/actions/guides/building-and-testing-nodejs.md b/content/actions/guides/building-and-testing-nodejs.md index bd06e9851c75..9d3788267663 100644 --- a/content/actions/guides/building-and-testing-nodejs.md +++ b/content/actions/guides/building-and-testing-nodejs.md @@ -8,6 +8,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'CI' @@ -17,6 +18,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction @@ -128,7 +130,10 @@ jobs: ``` {% endraw %} -If you don't specify a Node.js version, {% data variables.product.prodname_dotcom %} uses the environment's default Node.js version. For more information, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +If you don't specify a Node.js version, {% data variables.product.prodname_dotcom %} uses the environment's default Node.js version. +{% if currentVersion == "github-ae@latest" %} For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} For more information, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +{% endif %} ### Installing dependencies diff --git a/content/actions/guides/building-and-testing-powershell.md b/content/actions/guides/building-and-testing-powershell.md index 73db57f053b6..fe09913820eb 100644 --- a/content/actions/guides/building-and-testing-powershell.md +++ b/content/actions/guides/building-and-testing-powershell.md @@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' authors: - potatoqualitee type: 'tutorial' @@ -15,12 +16,17 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction This guide shows you how to use PowerShell for CI. It describes how to use Pester, install dependencies, test your module, and publish to the PowerShell Gallery. -{% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes PowerShell and Pester. For a full list of up-to-date software and the pre-installed versions of PowerShell and Pester, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +{% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes PowerShell and Pester. + +{% if currentVersion == "github-ae@latest" %}For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %}For a full list of up-to-date software and the pre-installed versions of PowerShell and Pester, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +{% endif %} ### Prerequisites @@ -64,7 +70,7 @@ jobs: * `run: Test-Path resultsfile.log` - Check whether a file called `resultsfile.log` is present in the repository's root directory. * `Should -Be $true` - Uses Pester to define an expected result. If the result is unexpected, then {% data variables.product.prodname_actions %} flags this as a failed test. For example: - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![Failed Pester test](/assets/images/help/repository/actions-failed-pester-test-updated.png) {% else %} ![Failed Pester test](/assets/images/help/repository/actions-failed-pester-test.png) diff --git a/content/actions/guides/building-and-testing-python.md b/content/actions/guides/building-and-testing-python.md index 5ee9c6b4b6f4..8c663e853383 100644 --- a/content/actions/guides/building-and-testing-python.md +++ b/content/actions/guides/building-and-testing-python.md @@ -7,6 +7,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'CI' @@ -15,12 +16,15 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction This guide shows you how to build, test, and publish a Python package. -{% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Python and PyPy. You don't have to install anything! For a full list of up-to-date software and the pre-installed versions of Python and PyPy, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +{% if currentVersion == "github-ae@latest" %} For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} {% data variables.product.prodname_dotcom %}-hosted runners have a tools cache with pre-installed software, which includes Python and PyPy. You don't have to install anything! For a full list of up-to-date software and the pre-installed versions of Python and PyPy, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +{% endif %} ### Prerequisites diff --git a/content/actions/guides/building-and-testing-ruby.md b/content/actions/guides/building-and-testing-ruby.md index 03c85c0a509a..c2dde2eef5c9 100644 --- a/content/actions/guides/building-and-testing-ruby.md +++ b/content/actions/guides/building-and-testing-ruby.md @@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'CI' @@ -13,6 +14,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/guides/caching-dependencies-to-speed-up-workflows.md b/content/actions/guides/caching-dependencies-to-speed-up-workflows.md index 571e3ef82003..963e410b3e0b 100644 --- a/content/actions/guides/caching-dependencies-to-speed-up-workflows.md +++ b/content/actions/guides/caching-dependencies-to-speed-up-workflows.md @@ -14,13 +14,15 @@ topics: - 'Workflows' --- +{% data reusables.actions.ae-beta %} + ### About caching workflow dependencies Workflow runs often reuse the same outputs or downloaded dependencies from one run to another. For example, package and dependency management tools such as Maven, Gradle, npm, and Yarn keep a local cache of downloaded dependencies. Jobs on {% data variables.product.prodname_dotcom %}-hosted runners start in a clean virtual environment and must download dependencies each time, causing increased network utilization, longer runtime, and increased cost. To help speed up the time it takes to recreate these files, {% data variables.product.prodname_dotcom %} can cache dependencies you frequently use in workflows. -To cache dependencies for a job, you'll need to use {% data variables.product.prodname_dotcom %}'s `cache` action. The action retrieves a cache identified by a unique key. For more information, see [`actions/cache`](https://github.com/actions/cache). +To cache dependencies for a job, you'll need to use {% data variables.product.prodname_dotcom %}'s `cache` action. The action retrieves a cache identified by a unique key. For more information, see [`actions/cache`](https://github.com/actions/cache). If you are caching Ruby gems, instead consider using the Ruby maintained action, which can cache bundle installs on initiation. For more information, see [`ruby/setup-ruby`](https://github.com/ruby/setup-ruby#caching-bundle-install-automatically). {% warning %} diff --git a/content/actions/guides/creating-postgresql-service-containers.md b/content/actions/guides/creating-postgresql-service-containers.md index 61e3ee912456..5c95d88d4ef2 100644 --- a/content/actions/guides/creating-postgresql-service-containers.md +++ b/content/actions/guides/creating-postgresql-service-containers.md @@ -9,6 +9,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Containers' @@ -17,6 +18,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/guides/creating-redis-service-containers.md b/content/actions/guides/creating-redis-service-containers.md index de5c6772109a..84b714f01da6 100644 --- a/content/actions/guides/creating-redis-service-containers.md +++ b/content/actions/guides/creating-redis-service-containers.md @@ -9,6 +9,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Containers' @@ -17,6 +18,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/guides/deploying-to-amazon-elastic-container-service.md b/content/actions/guides/deploying-to-amazon-elastic-container-service.md index 628d47a4db47..6e32e331f37d 100644 --- a/content/actions/guides/deploying-to-amazon-elastic-container-service.md +++ b/content/actions/guides/deploying-to-amazon-elastic-container-service.md @@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'CD' @@ -14,6 +15,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/guides/deploying-to-azure-app-service.md b/content/actions/guides/deploying-to-azure-app-service.md index 391bcdd288cb..68e4cf47157f 100644 --- a/content/actions/guides/deploying-to-azure-app-service.md +++ b/content/actions/guides/deploying-to-azure-app-service.md @@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'CD' @@ -14,6 +15,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/guides/deploying-to-google-kubernetes-engine.md b/content/actions/guides/deploying-to-google-kubernetes-engine.md index 8728dde11f2e..42bf9afef892 100644 --- a/content/actions/guides/deploying-to-google-kubernetes-engine.md +++ b/content/actions/guides/deploying-to-google-kubernetes-engine.md @@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'CD' @@ -14,6 +15,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/guides/index.md b/content/actions/guides/index.md index bb3ae78614ba..38acc216796f 100644 --- a/content/actions/guides/index.md +++ b/content/actions/guides/index.md @@ -17,6 +17,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' learningTracks: - getting_started - continuous_integration diff --git a/content/actions/guides/publishing-docker-images.md b/content/actions/guides/publishing-docker-images.md index 815b28215cdd..0421ca4cf9cb 100644 --- a/content/actions/guides/publishing-docker-images.md +++ b/content/actions/guides/publishing-docker-images.md @@ -7,6 +7,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Packaging' @@ -16,6 +17,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/guides/publishing-java-packages-with-gradle.md b/content/actions/guides/publishing-java-packages-with-gradle.md index 407d44644767..b9901a18d76f 100644 --- a/content/actions/guides/publishing-java-packages-with-gradle.md +++ b/content/actions/guides/publishing-java-packages-with-gradle.md @@ -7,6 +7,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Packaging' @@ -17,6 +18,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/guides/publishing-java-packages-with-maven.md b/content/actions/guides/publishing-java-packages-with-maven.md index 48a533fbf2ef..507f4cc9afe5 100644 --- a/content/actions/guides/publishing-java-packages-with-maven.md +++ b/content/actions/guides/publishing-java-packages-with-maven.md @@ -7,6 +7,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Packaging' @@ -17,6 +18,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/guides/publishing-nodejs-packages.md b/content/actions/guides/publishing-nodejs-packages.md index d1a3800318c9..3e359adce879 100644 --- a/content/actions/guides/publishing-nodejs-packages.md +++ b/content/actions/guides/publishing-nodejs-packages.md @@ -8,6 +8,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Packaging' @@ -18,6 +19,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/guides/setting-up-continuous-integration-using-workflow-templates.md b/content/actions/guides/setting-up-continuous-integration-using-workflow-templates.md index fd3a776b0963..d8a73183754d 100644 --- a/content/actions/guides/setting-up-continuous-integration-using-workflow-templates.md +++ b/content/actions/guides/setting-up-continuous-integration-using-workflow-templates.md @@ -11,6 +11,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Workflows' @@ -19,6 +20,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} Anyone with write permission to a repository can set up continuous integration (CI) using {% data variables.product.prodname_actions %}. diff --git a/content/actions/guides/storing-workflow-data-as-artifacts.md b/content/actions/guides/storing-workflow-data-as-artifacts.md index 898bf40efe83..ad3eed378275 100644 --- a/content/actions/guides/storing-workflow-data-as-artifacts.md +++ b/content/actions/guides/storing-workflow-data-as-artifacts.md @@ -11,6 +11,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Workflows' @@ -18,6 +19,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About workflow artifacts @@ -111,7 +113,7 @@ jobs: path: output/test/code-coverage.html ``` -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ### Configuring a custom artifact retention period You can define a custom retention period for individual artifacts created by a workflow. When using a workflow to create a new artifact, you can use `retention-days` with the `upload-artifact` action. This example demonstrates how to set a custom retention period of 5 days for the artifact named `my-artifact`: @@ -240,7 +242,7 @@ jobs: ``` The workflow run will archive any artifacts that it generated. For more information on downloading archived artifacts, see "[Downloading workflow artifacts](/actions/managing-workflow-runs/downloading-workflow-artifacts)." -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![Workflow that passes data between jobs to perform math](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow-updated.png) {% else %} ![Workflow that passes data between jobs to perform math](/assets/images/help/repository/passing-data-between-jobs-in-a-workflow.png) 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 346ccd21cccd..78f44b9d9308 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 @@ -7,11 +7,14 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'overview' --- +{% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About self-hosted runners @@ -112,6 +115,13 @@ Some extra configuration might be required to use actions from {% data variables The self-hosted runner polls {% data variables.product.product_name %} to retrieve application updates and to check if any jobs are queued for processing. The self-hosted runner uses a HTTPS _long poll_ that opens a connection to {% data variables.product.product_name %} for 50 seconds, and if no response is received, it then times out and creates a new long poll. The application must be running on the machine to accept and run {% data variables.product.prodname_actions %} jobs. +{% if currentVersion == "github-ae@latest" %} +You must ensure that the self-hosted runner has appropriate network access to communicate with the {% data variables.product.prodname_ghe_managed %} URL. +For example, if your instance name is `octoghae`, then you will need to allow the self-hosted runner to access `octoghae.github.com`. + +If you use an IP address allow list for your {% data variables.product.prodname_dotcom %} organization or enterprise account, you must add your self-hosted runner's IP address to the allow list. For more information, see "[Managing allowed IP addresses for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization#using-github-actions-with-an-ip-allow-list)." +{% endif %} + {% if currentVersion == "free-pro-team@latest" %} You must ensure that the machine has the appropriate network access to communicate with the {% data variables.product.prodname_dotcom %} URLs listed below. @@ -120,6 +130,7 @@ You must ensure that the machine has the appropriate network access to communica github.com api.github.com *.actions.githubusercontent.com +github-releases.githubusercontent.com codeload.github.com ``` diff --git a/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md b/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md index e8a3ec454b2d..454da2e3071d 100644 --- a/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/adding-self-hosted-runners.md @@ -7,11 +7,14 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' --- +{% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} You can add a self-hosted runner to a repository, an organization, or an enterprise. @@ -57,7 +60,7 @@ You can add self-hosted runners to an enterprise, where they can be assigned to {% if currentVersion == "free-pro-team@latest" %} To add a self-hosted runner to an enterprise account, you must be an enterprise owner. -{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21"%} +{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} To add a self-hosted runner at the enterprise level of {% data variables.product.product_location %}, you must be a site administrator. {% endif %} diff --git a/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md b/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md index e74b6cdeab51..bbde1784c8fe 100644 --- a/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md +++ b/content/actions/hosting-your-own-runners/configuring-the-self-hosted-runner-application-as-a-service.md @@ -6,12 +6,15 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' defaultPlatform: linux --- +{% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} {% capture service_first_step %}1. Stop the self-hosted runner application if it is currently running.{% endcapture %} {% capture service_non_windows_intro_shell %}On the runner machine, open a shell in the directory where you installed the self-hosted runner application. Use the commands below to install and manage the self-hosted runner service.{% endcapture %} diff --git a/content/actions/hosting-your-own-runners/index.md b/content/actions/hosting-your-own-runners/index.md index f73801b2ed7b..09276f2c2a34 100644 --- a/content/actions/hosting-your-own-runners/index.md +++ b/content/actions/hosting-your-own-runners/index.md @@ -7,10 +7,13 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- +{% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} {% link_in_list /about-self-hosted-runners %} {% link_in_list /adding-self-hosted-runners %} diff --git a/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md b/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md index 583e24c0b2bc..e045f5742237 100644 --- a/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md +++ b/content/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups.md @@ -6,11 +6,14 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' --- +{% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About self-hosted runner groups @@ -44,7 +47,7 @@ When creating a group, you must choose a policy that defines which repositories ![Add runner group](/assets/images/help/settings/actions-org-add-runner-group.png) 1. Enter a name for your runner group, and assign a policy for repository access. - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} You can configure a runner group to be accessible to a specific list of repositories, or to all repositories in the organization. By default, public repositories can't access runners in a runner group, but you can use the **Allow public repositories** option to override this.{% else if currentVersion == "enterprise-server@2.22"%}You can configure a runner group to be accessible to a specific list of repositories, all private repositories, or all repositories in the organization.{% endif %} + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} You can configure a runner group to be accessible to a specific list of repositories, or to all repositories in the organization. By default, only private repositories can access runners in a runner group, but you can override this.{% elsif currentVersion == "enterprise-server@2.22"%}You can configure a runner group to be accessible to a specific list of repositories, all private repositories, or all repositories in the organization.{% endif %} {% warning %} @@ -76,7 +79,7 @@ When creating a group, you must choose a policy that defines which organizations ![Add runner group](/assets/images/help/settings/actions-enterprise-account-add-runner-group.png) 1. Enter a name for your runner group, and assign a policy for organization access. - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} You can configure a runner group to be accessible to a specific list of organizations, or all organizations in the enterprise. By default, public repositories can't access runners in a runner group, but you can use the **Allow public repositories** option to override this.{% else if currentVersion == "enterprise-server@2.22"%}You can configure a runner group to be accessible to all organizations in the enterprise or choose specific organizations.{% endif %} + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} You can configure a runner group to be accessible to a specific list of organizations, or all organizations in the enterprise. By default, only private repositories can access runners in a runner group, but you can override this.{% elsif currentVersion == "enterprise-server@2.22"%}You can configure a runner group to be accessible to all organizations in the enterprise or choose specific organizations.{% endif %} {% warning %} @@ -101,7 +104,7 @@ You can update the access policy of a runner group, or rename a runner group. New self-hosted runners are automatically assigned to the default group, and can then be moved to another group. -1. In the **Self-hosted runners** section of the settings page, locate the current group of the runner you want to move group and expand the list of group members. +1. In the **Self-hosted runners** section of the settings page, locate the current group of the runner you want to move and expand the list of group members. ![View runner group members](/assets/images/help/settings/actions-org-runner-group-members.png) 1. Select the checkbox next to the self-hosted runner, and then click **Move to group** to see the available destinations. ![Runner group member move](/assets/images/help/settings/actions-org-runner-group-member-move.png) 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 36a11e07c232..42b189fcb55e 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 @@ -8,12 +8,15 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' defaultPlatform: linux --- +{% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Checking the status of a self-hosted runner diff --git a/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md b/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md index cd29dcd43b3a..3880818b21a2 100644 --- a/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/removing-self-hosted-runners.md @@ -7,11 +7,14 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' --- +{% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Removing a runner from a repository @@ -63,7 +66,7 @@ To remove a self-hosted runner from an organization, you must be an organization {% if currentVersion == "free-pro-team@latest" %} To remove a self-hosted runner from an enterprise account, you must be an enterprise owner. We recommend that you also have access to the self-hosted runner machine. -{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21"%} +{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21"% or currentVersion == "github-ae@latest" } To remove a self-hosted runner at the enterprise level of {% data variables.product.product_location %}, you must be a site administrator. We recommend that you also have access to the self-hosted runner machine. {% endif %} diff --git a/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md b/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md index c3b60531c350..faa10a7dddce 100644 --- a/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/using-a-proxy-server-with-self-hosted-runners.md @@ -6,11 +6,14 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' --- +{% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Configuring a proxy server using environment variables diff --git a/content/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners.md b/content/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners.md index 87ce2bbde199..91ad8eb2bab4 100644 --- a/content/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners.md +++ b/content/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners.md @@ -4,11 +4,14 @@ intro: You can use labels to organize your self-hosted runners based on their ch versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' --- +{% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} For information on how to use labels to route jobs to specific types of self-hosted runners, see "[Using self-hosted runners in a workflow](/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow)." diff --git a/content/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow.md b/content/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow.md index 3124b22d3d64..823d47baf017 100644 --- a/content/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow.md +++ b/content/actions/hosting-your-own-runners/using-self-hosted-runners-in-a-workflow.md @@ -7,11 +7,14 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' --- +{% data reusables.actions.ae-self-hosted-runners-notice %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} For information on creating custom and default labels, see "[Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners)." @@ -66,7 +69,7 @@ These labels operate cumulatively, so a self-hosted runner’s labels must match When routing a job to a self-hosted runner, {% data variables.product.prodname_dotcom %} looks for a runner that matches the job's `runs-on` labels: -1. {% data variables.product.prodname_dotcom %} first searches for a runner at the repository level, then at the organization level{% if currentVersion ver_gt "enterprise-server@2.21" %}, then at the enterprise level{% endif %}. +1. {% data variables.product.prodname_dotcom %} first searches for a runner at the repository level, then at the organization level{% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}, then at the enterprise level{% endif %}. 2. The job is then sent to the first matching runner that is online and idle. - If all matching online runners are busy, the job will queue at the level with the highest number of matching online runners. - If all matching runners are offline, the job will queue at the level with the highest number of matching offline runners. diff --git a/content/actions/index.md b/content/actions/index.md index a868a2f1fb54..48ff80ce2c95 100644 --- a/content/actions/index.md +++ b/content/actions/index.md @@ -45,6 +45,7 @@ layout: product-landing versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- @@ -52,6 +53,7 @@ versions: + diff --git a/content/actions/learn-github-actions/essential-features-of-github-actions.md b/content/actions/learn-github-actions/essential-features-of-github-actions.md index 4e1c1907ef24..e129ae19197f 100644 --- a/content/actions/learn-github-actions/essential-features-of-github-actions.md +++ b/content/actions/learn-github-actions/essential-features-of-github-actions.md @@ -5,6 +5,7 @@ intro: '{% data variables.product.prodname_actions %} are designed to help you b versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'overview' topics: - 'Fundamentals' @@ -12,6 +13,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Overview @@ -73,7 +75,7 @@ jobs: run: | expr 1 + 1 > output.log - name: Upload output file - uses: actions/upload-artifact@v1 + uses: actions/upload-artifact@v2 with: name: output-log-file path: output.log diff --git a/content/actions/learn-github-actions/finding-and-customizing-actions.md b/content/actions/learn-github-actions/finding-and-customizing-actions.md index bf6ef136cae0..2badabf20537 100644 --- a/content/actions/learn-github-actions/finding-and-customizing-actions.md +++ b/content/actions/learn-github-actions/finding-and-customizing-actions.md @@ -10,6 +10,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'how_to' topics: - 'Fundamentals' @@ -17,6 +18,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Overview @@ -73,7 +75,7 @@ steps: #### Using SHAs -If you need more reliable versioning, you should use the SHA value associated with the version of the action. SHAs are immutable and therefore more reliable than tags or branches. However this approach means you will not automatically receive updates for an action, including important bug fixes and security updates. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}You must use a commit's full SHA value, and not an abbreviated value. {% endif %}This example targets an action's SHA: +If you need more reliable versioning, you should use the SHA value associated with the version of the action. SHAs are immutable and therefore more reliable than tags or branches. However this approach means you will not automatically receive updates for an action, including important bug fixes and security updates. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}You must use a commit's full SHA value, and not an abbreviated value. {% endif %}This example targets an action's SHA: ```yaml steps: diff --git a/content/actions/learn-github-actions/index.md b/content/actions/learn-github-actions/index.md index e120b015a2b3..0ca62e32dc49 100644 --- a/content/actions/learn-github-actions/index.md +++ b/content/actions/learn-github-actions/index.md @@ -28,6 +28,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% link_with_intro /introduction-to-github-actions %} @@ -40,4 +41,4 @@ versions: {% link_with_intro /migrating-from-circleci-to-github-actions %} {% link_with_intro /migrating-from-gitlab-cicd-to-github-actions %} {% link_with_intro /migrating-from-jenkins-to-github-actions %} -{% link_with_intro /migrating-from-travis-ci-to-github-actions %} \ No newline at end of file +{% link_with_intro /migrating-from-travis-ci-to-github-actions %} diff --git a/content/actions/learn-github-actions/introduction-to-github-actions.md b/content/actions/learn-github-actions/introduction-to-github-actions.md index 495818104efa..c5bbb91f6bed 100644 --- a/content/actions/learn-github-actions/introduction-to-github-actions.md +++ b/content/actions/learn-github-actions/introduction-to-github-actions.md @@ -9,6 +9,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'overview' topics: - 'Fundamentals' @@ -16,6 +17,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Overview @@ -53,9 +55,10 @@ _Actions_ are standalone commands that are combined into _steps_ to create a _jo #### Runners -A runner is a server that has the [{% data variables.product.prodname_actions %} runner application](https://github.com/actions/runner) installed. You can use a runner hosted by {% data variables.product.prodname_dotcom %}, or you can host your own. A runner listens for available jobs, runs one job at a time, and reports the progress, logs, and results back to {% data variables.product.prodname_dotcom %}. For {% data variables.product.prodname_dotcom %}-hosted runners, each job in a workflow runs in a fresh virtual environment. - -{% data variables.product.prodname_dotcom %}-hosted runners are based on Ubuntu Linux, Microsoft Windows, and macOS. For information on {% data variables.product.prodname_dotcom %}-hosted runners, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/virtual-environments-for-github-hosted-runners)." If you need a different operating system or require a specific hardware configuration, you can host your own runners. For information on self-hosted runners, see "[Hosting your own runners](/actions/hosting-your-own-runners)." +{% if currentVersion == "github-ae@latest" %}A runner is a server that has the [{% data variables.product.prodname_actions %} runner application](https://github.com/actions/runner) installed. For {% data variables.product.prodname_ghe_managed %}, you can use the security hardened {% data variables.actions.hosted_runner %}s which are bundled with your instance in the cloud. A runner listens for available jobs, runs one job at a time, and reports the progress, logs, and results back to {% data variables.product.prodname_dotcom %}. {% data variables.actions.hosted_runner %}s run each workflow job in a fresh virtual environment. For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)." +{% else %} +A runner is a server that has the [{% data variables.product.prodname_actions %} runner application](https://github.com/actions/runner) installed. You can use a runner hosted by {% data variables.product.prodname_dotcom %}, or you can host your own. A runner listens for available jobs, runs one job at a time, and reports the progress, logs, and results back to {% data variables.product.prodname_dotcom %}. {% data variables.product.prodname_dotcom %}-hosted runners are based on Ubuntu Linux, Microsoft Windows, and macOS, and each job in a workflow runs in a fresh virtual environment. For information on {% data variables.product.prodname_dotcom %}-hosted runners, see "[About {% data variables.product.prodname_dotcom %}-hosted runners](/actions/using-github-hosted-runners/about-github-hosted-runners)." If you need a different operating system or require a specific hardware configuration, you can host your own runners. For information on self-hosted runners, see "[Hosting your own runners](/actions/hosting-your-own-runners)." +{% endif %} ### Create an example workflow @@ -207,7 +210,7 @@ In this diagram, you can see the workflow file you just created and how the {% d ### Viewing the job's activity -Once your job has started running, you can {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}see a visualization graph of the run's progress and {% endif %}view each step's activity on {% data variables.product.prodname_dotcom %}. +Once your job has started running, you can {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}see a visualization graph of the run's progress and {% endif %}view each step's activity on {% data variables.product.prodname_dotcom %}. {% data reusables.repositories.navigate-to-repo %} 1. Under your repository name, click **Actions**. @@ -216,11 +219,11 @@ Once your job has started running, you can {% if currentVersion == "free-pro-tea ![Screenshot of workflow results](/assets/images/help/images/learn-github-actions-workflow.png) 1. Under "Workflow runs", click the name of the run you want to see. ![Screenshot of workflow runs](/assets/images/help/images/learn-github-actions-run.png) -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} 1. Under **Jobs** or in the visualization graph, click the job you want to see. ![Select job](/assets/images/help/images/overview-actions-result-navigate.png) {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} 1. View the results of each step. ![Screenshot of workflow run details](/assets/images/help/images/overview-actions-result-updated-2.png) {% elsif currentVersion ver_gt "enterprise-server@2.22" %} diff --git a/content/actions/learn-github-actions/managing-complex-workflows.md b/content/actions/learn-github-actions/managing-complex-workflows.md index 17dc573c37c1..cb773b32c85f 100644 --- a/content/actions/learn-github-actions/managing-complex-workflows.md +++ b/content/actions/learn-github-actions/managing-complex-workflows.md @@ -1,10 +1,11 @@ --- title: Managing complex workflows shortTitle: Managing complex workflows -intro: 'This guide shows you how to use the advanced features of {% data variables.product.prodname_actions %}, with secret management, dependent jobs, caching, build matrices,{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} environments,{% endif %} and labels.' +intro: 'This guide shows you how to use the advanced features of {% data variables.product.prodname_actions %}, with secret management, dependent jobs, caching, build matrices,{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} environments,{% endif %} and labels.' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'how_to' topics: - 'Workflows' @@ -12,6 +13,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Overview @@ -86,6 +88,7 @@ jobs: For more information, see [`jobs..strategy.matrix`](/actions/reference/workflow-syntax-for-github-actions#jobsjob_idstrategymatrix). +{% if currentVersion == "free-pro-team@latest" %} ### Caching dependencies {% data variables.product.prodname_dotcom %}-hosted runners are started as fresh environments for each job, so if your jobs regularly reuse dependencies, you can consider caching these files to help improve performance. Once the cache is created, it is available to all workflows in the same repository. @@ -110,6 +113,7 @@ jobs: {% endraw %} For more information, see "Caching dependencies to speed up workflows." +{% endif %} ### Using databases and service containers @@ -139,17 +143,27 @@ For more information, see "[Using databases and service containers](/actions/con ### Using labels to route workflows -This feature helps you assign jobs to a specific self-hosted runner. If you want to be sure that a particular type of runner will process your job, you can use labels to control where jobs are executed. You can assign labels to a self-hosted runner, and then refer to these labels in your YAML workflow, ensuring that the job is routed in a predictable way. +This feature helps you assign jobs to a specific hosted runner. If you want to be sure that a particular type of runner will process your job, you can use labels to control where jobs are executed. You can assign labels to a hosted runner, and then refer to these labels in your YAML workflow, ensuring that the job is routed in a predictable way. +{% if currentVersion == "github-ae@latest" %} This example shows how a workflow can use labels to specify the required runner: +```yaml +jobs: + example-job: + runs-on: [AE-runner-for-CI] +``` + +For more information, see ["Using labels with {% data variables.actions.hosted_runner %}](/actions/using-github-hosted-runners/using-labels-with-ae-hosted-runners)." +{% else %} ```yaml jobs: example-job: runs-on: [self-hosted, linux, x64, gpu] ``` -For more information, see ["Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners)." +For more information, see ["Using labels with self-hosted runners](/actions/hosting-your-own-runners/using-labels-with-self-hosted-runners)." +{% endif %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} ### Using environments diff --git a/content/actions/learn-github-actions/migrating-from-azure-pipelines-to-github-actions.md b/content/actions/learn-github-actions/migrating-from-azure-pipelines-to-github-actions.md index b7ac0eaf559e..f43c7e05d30a 100644 --- a/content/actions/learn-github-actions/migrating-from-azure-pipelines-to-github-actions.md +++ b/content/actions/learn-github-actions/migrating-from-azure-pipelines-to-github-actions.md @@ -6,6 +6,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Azure Pipelines' @@ -16,6 +17,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/learn-github-actions/migrating-from-circleci-to-github-actions.md b/content/actions/learn-github-actions/migrating-from-circleci-to-github-actions.md index 6e1684ec0d25..cbb113098844 100644 --- a/content/actions/learn-github-actions/migrating-from-circleci-to-github-actions.md +++ b/content/actions/learn-github-actions/migrating-from-circleci-to-github-actions.md @@ -6,6 +6,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'CircleCI' @@ -16,6 +17,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction @@ -33,7 +35,9 @@ For more information, see "[Core concepts for {% data variables.product.prodname When migrating from CircleCI, consider the following differences: - CircleCI’s automatic test parallelism automatically groups tests according to user-specified rules or historical timing information. This functionality is not built into {% data variables.product.prodname_actions %}. -- Actions that execute in Docker containers are sensitive to permissions problems since containers have a different mapping of users. You can avoid many of these problems by not using the `USER` instruction in your *Dockerfile*. For more information about the Docker filesystem on {% data variables.product.product_name %}-hosted runners, see "[Virtual environments for {% data variables.product.product_name %}-hosted runners](/actions/reference/virtual-environments-for-github-hosted-runners#docker-container-filesystem)." +- Actions that execute in Docker containers are sensitive to permissions problems since containers have a different mapping of users. You can avoid many of these problems by not using the `USER` instruction in your *Dockerfile*. {% if currentVersion == "github-ae@latest" %}For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images).". +{% else %}For more information about the Docker filesystem on {% data variables.product.product_name %}-hosted runners, see "[Virtual environments for {% data variables.product.product_name %}-hosted runners](/actions/reference/virtual-environments-for-github-hosted-runners#docker-container-filesystem)." +{% endif %} ### Migrating workflows and jobs @@ -56,9 +60,15 @@ CircleCI provides a set of pre-built images with common dependencies. These imag We recommend that you move away from CircleCI's pre-built images when you migrate to {% data variables.product.prodname_actions %}. In many cases, you can use actions to install the additional dependencies you need. +{% if currentVersion == "github-ae@latest" %} +For more information about the Docker filesystem, see "[Docker container filesystem](/actions/using-github-hosted-runners/about-ae-hosted-runners#docker-container-filesystem)." + +For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} For more information about the Docker filesystem, see "[Virtual environments for {% data variables.product.product_name %}-hosted runners](/actions/reference/virtual-environments-for-github-hosted-runners#docker-container-filesystem)." For more information about the tools and packages available on {% data variables.product.prodname_dotcom %}-hosted virtual environments, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +{% endif %} ### Using variables and secrets @@ -107,7 +117,7 @@ GitHub Actions -{% data variables.product.prodname_actions %} caching is only applicable to {% data variables.product.prodname_dotcom %}-hosted runners. For more information, see "Caching dependencies to speed up workflows." +{% data variables.product.prodname_actions %} caching is only applicable for repositories hosted on {% data variables.product.prodname_dotcom_the_website %}. For more information, see "Caching dependencies to speed up workflows." {% data variables.product.prodname_actions %} does not have an equivalent of CircleCI’s Docker Layer Caching (or DLC). diff --git a/content/actions/learn-github-actions/migrating-from-gitlab-cicd-to-github-actions.md b/content/actions/learn-github-actions/migrating-from-gitlab-cicd-to-github-actions.md index e146bc69884e..19661d238b03 100644 --- a/content/actions/learn-github-actions/migrating-from-gitlab-cicd-to-github-actions.md +++ b/content/actions/learn-github-actions/migrating-from-gitlab-cicd-to-github-actions.md @@ -4,6 +4,7 @@ intro: '{% data variables.product.prodname_actions %} and GitLab CI/CD share sev versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'GitLab' @@ -14,6 +15,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction diff --git a/content/actions/learn-github-actions/migrating-from-jenkins-to-github-actions.md b/content/actions/learn-github-actions/migrating-from-jenkins-to-github-actions.md index bbcc743aacbd..6ea896566dc4 100644 --- a/content/actions/learn-github-actions/migrating-from-jenkins-to-github-actions.md +++ b/content/actions/learn-github-actions/migrating-from-jenkins-to-github-actions.md @@ -6,6 +6,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Jenkins' @@ -16,6 +17,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction @@ -69,7 +71,7 @@ Jenkins uses directives to manage _Declarative Pipelines_. These directives defi | [`triggers { upstreamprojects() }`](https://jenkins.io/doc/book/pipeline/syntax/#triggers) | [`jobs..needs`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idneeds) | | [Jenkins cron syntax](https://jenkins.io/doc/book/pipeline/syntax/#cron-syntax) | [`on.schedule`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#onschedule) | | [`stage`](https://jenkins.io/doc/book/pipeline/syntax/#stage) | [`jobs.`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_id)
[`jobs..name`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idname) | -| [`tools`](https://jenkins.io/doc/book/pipeline/syntax/#tools) | [Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software) | +| [`tools`](https://jenkins.io/doc/book/pipeline/syntax/#tools) | {% if currentVersion == "github-ae@latest" %}For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)."{% else %}[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software) |{% endif %} | [`input`](https://jenkins.io/doc/book/pipeline/syntax/#input) | [`inputs`](/actions/automating-your-workflow-with-github-actions/metadata-syntax-for-github-actions#inputs) | | [`when`](https://jenkins.io/doc/book/pipeline/syntax/#when) | [`jobs..if`](/actions/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idif) | diff --git a/content/actions/learn-github-actions/migrating-from-travis-ci-to-github-actions.md b/content/actions/learn-github-actions/migrating-from-travis-ci-to-github-actions.md index 9daceeafc0c2..9bcccc2b475e 100644 --- a/content/actions/learn-github-actions/migrating-from-travis-ci-to-github-actions.md +++ b/content/actions/learn-github-actions/migrating-from-travis-ci-to-github-actions.md @@ -6,6 +6,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'tutorial' topics: - 'Travis CI' @@ -14,6 +15,10 @@ topics: - 'CD' --- +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} + ### Introduction This guide helps you migrate from Travis CI to {% data variables.product.prodname_actions %}. It compares their concepts and syntax, describes the similarities, and demonstrates their different approaches to common tasks. @@ -182,7 +187,7 @@ When migrating from Travis CI, consider the following key features in {% data va #### Storing secrets -{% data variables.product.prodname_actions %} allows you to store secrets and reference them in your jobs. {% data variables.product.prodname_actions %} organizations can limit which repositories can access organization secrets. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}Environment protection rules can require manual approval for a workflow to access environment secrets. {% endif %}For more information, see "[Encrypted secrets](/actions/reference/encrypted-secrets)." +{% data variables.product.prodname_actions %} allows you to store secrets and reference them in your jobs. {% data variables.product.prodname_actions %} organizations can limit which repositories can access organization secrets. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}Environment protection rules can require manual approval for a workflow to access environment secrets. {% endif %}For more information, see "[Encrypted secrets](/actions/reference/encrypted-secrets)." #### Sharing files between jobs and workflows diff --git a/content/actions/learn-github-actions/security-hardening-for-github-actions.md b/content/actions/learn-github-actions/security-hardening-for-github-actions.md index 7185fae05b75..c606cf30e6c9 100644 --- a/content/actions/learn-github-actions/security-hardening-for-github-actions.md +++ b/content/actions/learn-github-actions/security-hardening-for-github-actions.md @@ -8,6 +8,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'overview' topics: - 'Security' @@ -15,6 +16,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Overview @@ -22,7 +24,7 @@ This guide explains how to configure security hardening for certain {% data vari ### Using secrets -Sensitive values should never be stored as plaintext in workflow files, but rather as secrets. [Secrets](/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) can be configured at the organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}, repository, or environment{% else %} or repository{% endif %} level, and allow you to store sensitive information in {% data variables.product.product_name %}. +Sensitive values should never be stored as plaintext in workflow files, but rather as secrets. [Secrets](/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets) can be configured at the organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}, repository, or environment{% else %} or repository{% endif %} level, and allow you to store sensitive information in {% data variables.product.product_name %}. Secrets use [Libsodium sealed boxes](https://libsodium.gitbook.io/doc/public-key_cryptography/sealed_boxes), so that they are encrypted before reaching {% data variables.product.product_name %}. This occurs when the secret is submitted [using the UI](/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets#creating-encrypted-secrets-for-a-repository) or through the [REST API](/rest/reference/actions#secrets). This client-side encryption helps the minimize risks related to accidental logging (for example, exception logs and request logs, among others) within {% data variables.product.product_name %}'s infrastructure. Once the secret is uploaded, {% data variables.product.product_name %} is then able to decrypt it so that it can be injected into the workflow runtime. @@ -41,7 +43,7 @@ To help prevent accidental disclosure, {% data variables.product.product_name %} - **Audit and rotate registered secrets** - Periodically review the registered secrets to confirm they are still required. Remove those that are no longer needed. - Rotate secrets periodically to reduce the window of time during which a compromised secret is valid. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} - **Consider requiring review for access to secrets** - You can use required reviewers to protect environment secrets. A workflow job cannot access environment secrets until approval is granted by a reviewer. For more information about storing secrets in environments or requiring reviews for environments, see "[Encrypted secrets](/actions/reference/encrypted-secrets)" and "[Environments](/actions/reference/environments)." {% endif %} @@ -75,7 +77,7 @@ This means that a compromise of a single action within a workflow can be very si ### Considering cross-repository access -{% data variables.product.product_name %} is intentionally scoped for a single repository at a time. The `GITHUB_TOKEN` grants the same level of access as a write-access user, because any write-access user can access this token by creating or modifying workflow files. Users have specific permissions for each repository, so having the `GITHUB_TOKEN` for one repository grant access to another would impact the {% data variables.product.prodname_dotcom %} permission model if not implemented carefully. Similarly, caution must be taken when adding {% data variables.product.prodname_dotcom %} authentication tokens to a workflow, because this can also affect the {% data variables.product.prodname_dotcom %} permission model by inadvertently granting broad access to collaborators. +{% data variables.product.prodname_actions %} is intentionally scoped for a single repository at a time. The `GITHUB_TOKEN` grants the same level of access as a write-access user, because any write-access user can access this token by creating or modifying workflow files. Users have specific permissions for each repository, so having the `GITHUB_TOKEN` for one repository grant access to another would impact the {% data variables.product.prodname_dotcom %} permission model if not implemented carefully. Similarly, caution must be taken when adding {% data variables.product.prodname_dotcom %} authentication tokens to a workflow, because this can also affect the {% data variables.product.prodname_dotcom %} permission model by inadvertently granting broad access to collaborators. We have [a plan on the {% data variables.product.prodname_dotcom %} roadmap](https://github.com/github/roadmap/issues/74) to support a flow that allows cross-repository access within {% data variables.product.product_name %}, but this is not yet a supported feature. Currently, the only way to perform privileged cross-repository interactions is to place a {% data variables.product.prodname_dotcom %} authentication token or SSH key as a secret within the workflow. Because many authentication token types do not allow for granular access to specific resources, there is significant risk in using the wrong token type, as it can grant much broader access than intended. @@ -131,7 +133,6 @@ The following tables describe the {% data variables.product.prodname_actions %} | `repo.remove_actions_secret` | Triggered when a {% data variables.product.prodname_actions %} secret is removed. | `repo.update_actions_secret` | Triggered when a {% data variables.product.prodname_actions %} secret is updated. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} #### Events for self-hosted runners | Action | Description |------------------|------------------- @@ -143,9 +144,7 @@ The following tables describe the {% data variables.product.prodname_actions %} | `repo.register_self_hosted_runner` | Triggered when a new self-hosted runner is registered. For more information, see "[Adding a self-hosted runner to a repository](/actions/hosting-your-own-runners/adding-self-hosted-runners#adding-a-self-hosted-runner-to-a-repository)." | `repo.remove_self_hosted_runner` | Triggered when a self-hosted runner is removed. For more information, see "[Removing a runner from a repository](/actions/hosting-your-own-runners/removing-self-hosted-runners#removing-a-runner-from-a-repository)." | `repo.self_hosted_runner_updated` | Triggered when the runner application is updated. Can be viewed using the REST API and the UI; not visible in the JSON/CSV export. For more information, see "[About self-hosted runners](/actions/hosting-your-own-runners/about-self-hosted-runners#about-self-hosted-runners)." -{% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} #### Events for self-hosted runner groups | Action | Description |------------------|------------------- @@ -158,11 +157,7 @@ The following tables describe the {% data variables.product.prodname_actions %} | `org.runner_group_removed` | Triggered when a self-hosted runner group is removed. For more information, see "[Removing a self-hosted runner group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#removing-a-self-hosted-runner-group)." | `org.runner_group_runners_added` | Triggered when a self-hosted runner is added to a group. For more information, see "[Moving a self-hosted runner to a group](/actions/hosting-your-own-runners/managing-access-to-self-hosted-runners-using-groups#moving-a-self-hosted-runner-to-a-group)." | `org.runner_group_runner_removed` | Triggered when a self-hosted runner is removed from a group. -{% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} #### Events for workflow activities {% data reusables.actions.actions-audit-events-workflow %} - -{% endif %} diff --git a/content/actions/learn-github-actions/sharing-workflows-with-your-organization.md b/content/actions/learn-github-actions/sharing-workflows-with-your-organization.md index 264a15171fab..9031151f9dc5 100644 --- a/content/actions/learn-github-actions/sharing-workflows-with-your-organization.md +++ b/content/actions/learn-github-actions/sharing-workflows-with-your-organization.md @@ -7,11 +7,13 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'how_to' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Overview diff --git a/content/actions/managing-workflow-runs/adding-a-workflow-status-badge.md b/content/actions/managing-workflow-runs/adding-a-workflow-status-badge.md index 92fa7fc3d7aa..a5f04694bca2 100644 --- a/content/actions/managing-workflow-runs/adding-a-workflow-status-badge.md +++ b/content/actions/managing-workflow-runs/adding-a-workflow-status-badge.md @@ -5,10 +5,12 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} {% data reusables.repositories.actions-workflow-status-badge-into %} diff --git a/content/actions/managing-workflow-runs/canceling-a-workflow.md b/content/actions/managing-workflow-runs/canceling-a-workflow.md index 153659d966a7..14c6714dd271 100644 --- a/content/actions/managing-workflow-runs/canceling-a-workflow.md +++ b/content/actions/managing-workflow-runs/canceling-a-workflow.md @@ -5,10 +5,12 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} {% data reusables.repositories.permissions-statement-write %} @@ -20,7 +22,7 @@ versions: 1. From the list of workflow runs, click the name of the `queued` or `in progress` run that you want to cancel. ![Name of workflow run](/assets/images/help/repository/in-progress-run.png) 1. In the upper-right corner of the workflow, click **Cancel workflow**. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![Cancel check suite button](/assets/images/help/repository/cancel-check-suite-updated.png) {% else %} ![Cancel check suite button](/assets/images/help/repository/cancel-check-suite.png) diff --git a/content/actions/managing-workflow-runs/deleting-a-workflow-run.md b/content/actions/managing-workflow-runs/deleting-a-workflow-run.md index 18ebe8c5ccb3..f81c4797116b 100644 --- a/content/actions/managing-workflow-runs/deleting-a-workflow-run.md +++ b/content/actions/managing-workflow-runs/deleting-a-workflow-run.md @@ -5,10 +5,12 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} {% data reusables.repositories.permissions-statement-write %} diff --git a/content/actions/managing-workflow-runs/disabling-and-enabling-a-workflow.md b/content/actions/managing-workflow-runs/disabling-and-enabling-a-workflow.md index c4dbd756452e..9cd84a31faf8 100644 --- a/content/actions/managing-workflow-runs/disabling-and-enabling-a-workflow.md +++ b/content/actions/managing-workflow-runs/disabling-and-enabling-a-workflow.md @@ -5,10 +5,12 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.23' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} Disabling a workflow allows you to stop a workflow from being triggered without having to delete the file from the repo. You can easily re-enable the workflow again on {% data variables.product.prodname_dotcom %}. You can also disable and enable a workflow using the REST API. For more information, see the "[Actions REST API](/rest/reference/actions#workflows)." diff --git a/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md b/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md index 11843c3cec93..df597aa7ac94 100644 --- a/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md +++ b/content/actions/managing-workflow-runs/downloading-workflow-artifacts.md @@ -5,12 +5,14 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and you can customize this retention period, depending on the type of repository. For more information, see "[Configuring the retention period for GitHub Actions artifacts and logs in your repository](/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)."{% endif %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and you can customize this retention period, depending on the type of repository. For more information, see "[Configuring the retention period for GitHub Actions artifacts and logs in your repository](/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository)."{% endif %} {% if currentVersion == "enterprise-server@2.22" %} {% data variables.product.product_name %} stores full build logs and artifacts for 90 days.{% endif %} {% data reusables.repositories.permissions-statement-read %} @@ -20,7 +22,7 @@ versions: {% data reusables.repositories.navigate-to-workflow %} {% data reusables.repositories.view-run %} 1. Under **Artifacts**, click the artifact you want to download. - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down-updated.png) {% else %} ![Download artifact drop-down menu](/assets/images/help/repository/artifact-drop-down.png) diff --git a/content/actions/managing-workflow-runs/enabling-debug-logging.md b/content/actions/managing-workflow-runs/enabling-debug-logging.md index a4787be05af4..a4e5ac69a033 100644 --- a/content/actions/managing-workflow-runs/enabling-debug-logging.md +++ b/content/actions/managing-workflow-runs/enabling-debug-logging.md @@ -5,15 +5,17 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} These extra logs are enabled by setting secrets in the repository containing the workflow, so the same permissions requirements will apply: - {% data reusables.github-actions.permissions-statement-secrets-repository %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} - {% data reusables.github-actions.permissions-statement-secrets-environment %} {% endif %} - {% data reusables.github-actions.permissions-statement-secrets-organization %} diff --git a/content/actions/managing-workflow-runs/index.md b/content/actions/managing-workflow-runs/index.md index 4d5e7554b128..2606df2f970c 100644 --- a/content/actions/managing-workflow-runs/index.md +++ b/content/actions/managing-workflow-runs/index.md @@ -1,7 +1,7 @@ --- title: Managing workflow runs shortTitle: Managing workflow runs -intro: 'You can view the status and results of each step in your workflow, cancel a pending workflow, {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}review deployments, {% endif %}view billable job execution minutes, debug and re-run a failed workflow, search and download logs, and download artifacts.' +intro: 'You can view the status and results of each step in your workflow, cancel a pending workflow, {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}review deployments, {% endif %}view billable job execution minutes, debug and re-run a failed workflow, search and download logs, and download artifacts.' redirect_from: - /actions/configuring-and-managing-workflows/managing-a-workflow-run - /articles/viewing-your-repository-s-workflows @@ -13,12 +13,14 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}{% link_in_list /using-the-visualization-graph %}{% endif %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}{% link_in_list /using-the-visualization-graph %}{% endif %} {% link_in_list /viewing-workflow-run-history %} {% link_in_list /using-workflow-run-logs %} {% link_in_list /manually-running-a-workflow %} diff --git a/content/actions/managing-workflow-runs/manually-running-a-workflow.md b/content/actions/managing-workflow-runs/manually-running-a-workflow.md index 753dda70cb69..55a78bf07c0f 100644 --- a/content/actions/managing-workflow-runs/manually-running-a-workflow.md +++ b/content/actions/managing-workflow-runs/manually-running-a-workflow.md @@ -5,10 +5,12 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Configuring a workflow to run manually diff --git a/content/actions/managing-workflow-runs/re-running-a-workflow.md b/content/actions/managing-workflow-runs/re-running-a-workflow.md index 323ebab2d31f..f72ee39863cd 100644 --- a/content/actions/managing-workflow-runs/re-running-a-workflow.md +++ b/content/actions/managing-workflow-runs/re-running-a-workflow.md @@ -5,10 +5,12 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} {% data reusables.repositories.permissions-statement-write %} @@ -16,4 +18,4 @@ versions: {% data reusables.repositories.actions-tab %} {% data reusables.repositories.navigate-to-workflow %} {% data reusables.repositories.view-run %} -1. In the upper-right corner of the workflow, use the **Re-run jobs** drop-down menu, and select **Re-run all jobs**.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}![Re-run checks drop-down menu](/assets/images/help/repository/rerun-checks-drop-down-updated.png){% else %}![Re-run checks drop-down menu](/assets/images/help/repository/rerun-checks-drop-down.png){% endif %} +1. In the upper-right corner of the workflow, use the **Re-run jobs** drop-down menu, and select **Re-run all jobs**.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}![Re-run checks drop-down menu](/assets/images/help/repository/rerun-checks-drop-down-updated.png){% else %}![Re-run checks drop-down menu](/assets/images/help/repository/rerun-checks-drop-down.png){% endif %} diff --git a/content/actions/managing-workflow-runs/removing-workflow-artifacts.md b/content/actions/managing-workflow-runs/removing-workflow-artifacts.md index 33595a42cfb0..a433c07caab8 100644 --- a/content/actions/managing-workflow-runs/removing-workflow-artifacts.md +++ b/content/actions/managing-workflow-runs/removing-workflow-artifacts.md @@ -5,10 +5,12 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Deleting an artifact @@ -27,13 +29,13 @@ versions: {% data reusables.repositories.navigate-to-workflow %} {% data reusables.repositories.view-run %} 1. Under **Artifacts**, click {% octicon "trashcan" aria-label="The trashcan icon" %} next to the artifact you want to remove. - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![Delete artifact drop-down menu](/assets/images/help/repository/actions-delete-artifact-updated.png) {% else %} ![Delete artifact drop-down menu](/assets/images/help/repository/actions-delete-artifact.png) {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ### Setting the retention period for an artifact Retention periods for artifacts and logs can be configured at the repository, organization, and enterprise level. For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#artifact-and-log-retention-policy)." diff --git a/content/actions/managing-workflow-runs/reviewing-deployments.md b/content/actions/managing-workflow-runs/reviewing-deployments.md index 3df0e347630a..a2fb11eb67f0 100644 --- a/content/actions/managing-workflow-runs/reviewing-deployments.md +++ b/content/actions/managing-workflow-runs/reviewing-deployments.md @@ -5,9 +5,11 @@ product: '{% data reusables.gated-features.environments %}' versions: free-pro-team: '*' enterprise-server: '>=3.1' + github-ae: '*' --- {% data reusables.actions.environments-beta %} +{% data reusables.actions.ae-beta %} ### About required reviews in workflows diff --git a/content/actions/managing-workflow-runs/using-the-visualization-graph.md b/content/actions/managing-workflow-runs/using-the-visualization-graph.md index 2fe6753a3031..2fbeb2a9ae2a 100644 --- a/content/actions/managing-workflow-runs/using-the-visualization-graph.md +++ b/content/actions/managing-workflow-runs/using-the-visualization-graph.md @@ -5,11 +5,13 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=3.1' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.visualization-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.actions-tab %} diff --git a/content/actions/managing-workflow-runs/using-workflow-run-logs.md b/content/actions/managing-workflow-runs/using-workflow-run-logs.md index 9cffb45bc3d6..fa3973fb9432 100644 --- a/content/actions/managing-workflow-runs/using-workflow-run-logs.md +++ b/content/actions/managing-workflow-runs/using-workflow-run-logs.md @@ -5,10 +5,12 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} You can see whether a workflow run is in progress or complete from the workflow run page. You must be logged in to a {% data variables.product.prodname_dotcom %} account to view workflow run information, including for public repositories. For more information, see "[Access permissions on GitHub](/articles/access-permissions-on-github)." @@ -43,9 +45,9 @@ You can search the build logs for a particular step. When you search logs, only {% data reusables.repositories.navigate-to-workflow-superlinter %} {% data reusables.repositories.view-run-superlinter %} {% data reusables.repositories.navigate-to-job-superlinter %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} 1. In the upper-right corner of the log output, in the **Search logs** search box, type a search query. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![Search box to search logs](/assets/images/help/repository/search-log-box-updated-2.png) {% else %} ![Search box to search logs](/assets/images/help/repository/search-log-box-updated.png) @@ -66,9 +68,9 @@ You can download the log files from your workflow run. You can also download a w {% data reusables.repositories.navigate-to-workflow-superlinter %} {% data reusables.repositories.view-run-superlinter %} {% data reusables.repositories.navigate-to-job-superlinter %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} -1. In the upper right corner, click {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}{% octicon "gear" aria-label="The gear icon" %}{% else %}{% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}{% endif %} and select **Download log archive**. - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} +1. In the upper right corner, click {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}{% octicon "gear" aria-label="The gear icon" %}{% else %}{% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}{% endif %} and select **Download log archive**. + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![Download logs drop-down menu](/assets/images/help/repository/download-logs-drop-down-updated-2.png) {% else %} ![Download logs drop-down menu](/assets/images/help/repository/download-logs-drop-down-updated.png) @@ -86,15 +88,15 @@ You can delete the log files from your workflow run. {% data reusables.repositor {% data reusables.repositories.actions-tab %} {% data reusables.repositories.navigate-to-workflow-superlinter %} {% data reusables.repositories.view-run-superlinter %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} 1. In the upper right corner, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %}. - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![Kebab-horizontal icon](/assets/images/help/repository/workflow-run-kebab-horizontal-icon-updated-2.png) {% else %} ![Kebab-horizontal icon](/assets/images/help/repository/workflow-run-kebab-horizontal-icon-updated.png) {% endif %} 2. To delete the log files, click the **Delete all logs** button and review the confirmation prompt. - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ![Delete all logs](/assets/images/help/repository/delete-all-logs-updated-2.png) {% else %} ![Delete all logs](/assets/images/help/repository/delete-all-logs-updated.png) diff --git a/content/actions/managing-workflow-runs/viewing-job-execution-time.md b/content/actions/managing-workflow-runs/viewing-job-execution-time.md index e1b7bd9ac007..87c41449d491 100644 --- a/content/actions/managing-workflow-runs/viewing-job-execution-time.md +++ b/content/actions/managing-workflow-runs/viewing-job-execution-time.md @@ -8,6 +8,7 @@ versions: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} Billable job execution minutes are only shown for jobs run on private repositories that use {% data variables.product.prodname_dotcom %}-hosted runners. There are no billable minutes when using {% data variables.product.prodname_actions %} in public repositories or for jobs run on self-hosted runners. diff --git a/content/actions/managing-workflow-runs/viewing-workflow-run-history.md b/content/actions/managing-workflow-runs/viewing-workflow-run-history.md index 47ca04068ef3..284bd3fcd930 100644 --- a/content/actions/managing-workflow-runs/viewing-workflow-run-history.md +++ b/content/actions/managing-workflow-runs/viewing-workflow-run-history.md @@ -5,10 +5,12 @@ product: '{% data reusables.gated-features.actions %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} {% data reusables.repositories.permissions-statement-read %} diff --git a/content/actions/quickstart.md b/content/actions/quickstart.md index 3463cb3406a3..fa57cf9deb7e 100644 --- a/content/actions/quickstart.md +++ b/content/actions/quickstart.md @@ -7,6 +7,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' type: 'quick_start' topics: - 'Fundamentals' @@ -14,6 +15,7 @@ topics: {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Introduction @@ -63,7 +65,7 @@ Committing the workflow file in your repository triggers the `push` event and ru {% data reusables.repositories.actions-tab %} {% data reusables.repositories.navigate-to-workflow-superlinter %} {% data reusables.repositories.view-run-superlinter %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} 1. Under **Jobs** or in the visualization graph, click the **Lint code base** job. ![Lint code base job](/assets/images/help/repository/superlinter-lint-code-base-job-updated.png) {% else %} diff --git a/content/actions/reference/authentication-in-a-workflow.md b/content/actions/reference/authentication-in-a-workflow.md index 5db39077b94e..a4a0b047a43e 100644 --- a/content/actions/reference/authentication-in-a-workflow.md +++ b/content/actions/reference/authentication-in-a-workflow.md @@ -9,10 +9,12 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About the `GITHUB_TOKEN` secret diff --git a/content/actions/reference/context-and-expression-syntax-for-github-actions.md b/content/actions/reference/context-and-expression-syntax-for-github-actions.md index 3fa953b67772..8bdfedc6e82b 100644 --- a/content/actions/reference/context-and-expression-syntax-for-github-actions.md +++ b/content/actions/reference/context-and-expression-syntax-for-github-actions.md @@ -11,10 +11,12 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About contexts and expressions @@ -156,7 +158,8 @@ The `runner` context contains information about the runner that is executing the |---------------|------|-------------| | `runner.os` | `string` | The operating system of the runner executing the job. Possible values are `Linux`, `Windows`, or `macOS`. | | `runner.temp` | `string` | The path of the temporary directory for the runner. This directory is guaranteed to be empty at the start of each job, even on self-hosted runners. | -| `runner.tool_cache` | `string` | The path of the directory containing some of the preinstalled tools for {% data variables.product.prodname_dotcom %}-hosted runners. For more information, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". | +| `runner.tool_cache` | `string` | {% if currentVersion == "github-ae@latest" %}For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %}The path of the directory containing some of the preinstalled tools for {% data variables.product.prodname_dotcom %}-hosted runners. For more information, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". {% endif %}| #### `needs` context diff --git a/content/actions/reference/encrypted-secrets.md b/content/actions/reference/encrypted-secrets.md index f7f502c99d00..c6dda65cfddf 100644 --- a/content/actions/reference/encrypted-secrets.md +++ b/content/actions/reference/encrypted-secrets.md @@ -9,19 +9,21 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.environments-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About encrypted secrets -Secrets are encrypted environment variables that you create in an organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}, repository, or repository environment{% else %} or repository{% endif %}. The secrets that you create are available to use in {% data variables.product.prodname_actions %} workflows. {% data variables.product.prodname_dotcom %} uses a [libsodium sealed box](https://libsodium.gitbook.io/doc/public-key_cryptography/sealed_boxes) to help ensure that secrets are encrypted before they reach {% data variables.product.prodname_dotcom %} and remain encrypted until you use them in a workflow. +Secrets are encrypted environment variables that you create in an organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}, repository, or repository environment{% else %} or repository{% endif %}. The secrets that you create are available to use in {% data variables.product.prodname_actions %} workflows. {% data variables.product.prodname_dotcom %} uses a [libsodium sealed box](https://libsodium.gitbook.io/doc/public-key_cryptography/sealed_boxes) to help ensure that secrets are encrypted before they reach {% data variables.product.prodname_dotcom %} and remain encrypted until you use them in a workflow. {% data reusables.github-actions.secrets-org-level-overview %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} For secrets stored at the environment level, you can enable required reviewers to control access to the secrets. A workflow job cannot access environment secrets until approval is granted by required approvers. {% endif %} @@ -33,9 +35,9 @@ The following rules apply to secret names: * Secret names must not start with the `GITHUB_` prefix. * Secret names must not start with a number. * Secret names are not case-sensitive. -* Secret names must be unique at the level they are created at. For example, {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}a secret created at the environment level must have a unique name in that environment, {% endif %}a secret created at the repository level must have a unique name in that repository, and a secret created at the organization level must have a unique name at that level. +* Secret names must be unique at the level they are created at. For example, {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}a secret created at the environment level must have a unique name in that environment, {% endif %}a secret created at the repository level must have a unique name in that repository, and a secret created at the organization level must have a unique name at that level. - If a secret with the same name exists at multiple levels, the secret at the lower level takes precedence. For example, if an organization-level secret has the same name as a repository-level secret, then the repository-level secret takes precedence.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} Similarly, if an organization, repository, and environment all have a secret with the same name, the environment-level secret takes precedence.{% endif %} + If a secret with the same name exists at multiple levels, the secret at the lower level takes precedence. For example, if an organization-level secret has the same name as a repository-level secret, then the repository-level secret takes precedence.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} Similarly, if an organization, repository, and environment all have a secret with the same name, the environment-level secret takes precedence.{% endif %} To help ensure that {% data variables.product.prodname_dotcom %} redacts your secret in logs, avoid using structured data as the values of secrets. For example, avoid creating secrets that contain JSON or encoded Git blobs. @@ -51,7 +53,7 @@ You can use and read encrypted secrets in a workflow file if you have access to {% endwarning %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} Organization and repository secrets are read when a workflow run is queued, and environment secrets are read when a job referencing the environment starts. {% endif %} @@ -73,9 +75,15 @@ When generating credentials, we recommend that you grant the minimum permissions 1. Enter the value for your secret. 1. Click **Add secret**. -If your repository {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}has environment secrets or {% endif %}can access secrets from the parent organization, then those secrets are also listed on this page. +If your repository {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0"or currentVersion == "github-ae@latest" %}has environment secrets or {% endif %}can access secrets from the parent organization, then those secrets are also listed on this page. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% note %} + +**Note:** Users with collaborator access can use the REST API to manage secrets for a repository. For more information, see "[{% data variables.product.prodname_actions %} secrets API](/rest/reference/actions#secrets)." + +{% endnote %} + +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" } ### Creating encrypted secrets for an environment {% data reusables.github-actions.permissions-statement-secrets-environment %} @@ -178,7 +186,7 @@ steps: ### Limits for secrets -You can store up to 1,000 secrets per organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}, 100 secrets per repository, and 100 secrets per environment{% else %} and 100 secrets per repository{% endif %}. A workflow may use up to 100 organization secrets and 100 repository secrets.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} Additionally, a job referencing an environment may use up to 100 environment secrets.{% endif %} +You can store up to 1,000 secrets per organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}, 100 secrets per repository, and 100 secrets per environment{% else %} and 100 secrets per repository{% endif %}. A workflow may use up to 100 organization secrets and 100 repository secrets.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} Additionally, a job referencing an environment may use up to 100 environment secrets.{% endif %} Secrets are limited to 64 KB in size. To use secrets that are larger than 64 KB, you can store encrypted secrets in your repository and save the decryption passphrase as a secret on {% data variables.product.prodname_dotcom %}. For example, you can use `gpg` to encrypt your credentials locally before checking the file in to your repository on {% data variables.product.prodname_dotcom %}. For more information, see the "[gpg manpage](https://www.gnupg.org/gph/de/manual/r1023.html)." diff --git a/content/actions/reference/environment-variables.md b/content/actions/reference/environment-variables.md index 2677930a5601..78b6e0a93bd7 100644 --- a/content/actions/reference/environment-variables.md +++ b/content/actions/reference/environment-variables.md @@ -9,10 +9,12 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About environment variables @@ -40,7 +42,7 @@ To use the value of an environment variable in a workflow file, you should use t If you use the workflow file's `run` key to read environment variables from within the runner operating system (as shown in the example above), the variable is substituted in the runner operating system after the job is sent to the runner. For other parts of a workflow file, you must use the `env` context to read environment variables; this is because workflow keys (such as `if`) require the variable to be substituted during workflow processing before it is sent to the runner. -You can also use the {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}`GITHUB_ENV` environment file{% else %} `set-env` workflow command{% endif %} to set an environment variable that the following steps in a workflow can use. The {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}environment file{% else %} `set-env` command{% endif %} can be used directly by an action or as a shell command in a workflow file using the `run` keyword. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/reference/workflow-commands-for-github-actions/#setting-an-environment-variable)." +You can also use the {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}`GITHUB_ENV` environment file{% else %} `set-env` workflow command{% endif %} to set an environment variable that the following steps in a workflow can use. The {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}environment file{% else %} `set-env` command{% endif %} can be used directly by an action or as a shell command in a workflow file using the `run` keyword. For more information, see "[Workflow commands for {% data variables.product.prodname_actions %}](/actions/reference/workflow-commands-for-github-actions/#setting-an-environment-variable)." ### Default environment variables diff --git a/content/actions/reference/environments.md b/content/actions/reference/environments.md index cfbdbfc1cd2e..24221ac7b998 100644 --- a/content/actions/reference/environments.md +++ b/content/actions/reference/environments.md @@ -5,9 +5,11 @@ product: '{% data reusables.gated-features.environments %}' versions: free-pro-team: '*' enterprise-server: '>=3.1' + github-ae: '*' --- {% data reusables.actions.environments-beta %} +{% data reusables.actions.ae-beta %} ### About environments diff --git a/content/actions/reference/events-that-trigger-workflows.md b/content/actions/reference/events-that-trigger-workflows.md index 7bb9d38713f1..9f3e2327e2ec 100644 --- a/content/actions/reference/events-that-trigger-workflows.md +++ b/content/actions/reference/events-that-trigger-workflows.md @@ -10,10 +10,12 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Configuring workflow events @@ -586,7 +588,7 @@ on: {% data reusables.developer-site.pull_request_forked_repos_link %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} #### `pull_request_target` @@ -594,7 +596,7 @@ This event runs in the context of the base of the pull request, rather than in t {% warning %} -**Warning:** The `pull_request_target` event is granted a read/write repository token and can access secrets, even when it is triggered from a fork. Although the workflow runs in the context of the base of the pull request, you should make sure that you do not check out, build, or run untrusted code from the pull request with this event. Additionally, any caches share the same scope as the base branch, and to help prevent cache poisoning, you should not save the cache if there is a possibility that the cache contents were altered. +**Warning:** The `pull_request_target` event is granted a read/write repository token and can access secrets, even when it is triggered from a fork. Although the workflow runs in the context of the base of the pull request, you should make sure that you do not check out, build, or run untrusted code from the pull request with this event. Additionally, any caches share the same scope as the base branch, and to help prevent cache poisoning, you should not save the cache if there is a possibility that the cache contents were altered. For more information, see "[Keeping your GitHub Actions and workflows secure: Preventing pwn requests](https://securitylab.github.com/research/github-actions-preventing-pwn-requests)" on the GitHub Security Lab website. {% endwarning %} @@ -714,7 +716,7 @@ on: types: [started] ``` -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} #### `workflow_run` diff --git a/content/actions/reference/index.md b/content/actions/reference/index.md index c94ae2f4eb58..11a946236e9e 100644 --- a/content/actions/reference/index.md +++ b/content/actions/reference/index.md @@ -6,10 +6,12 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### Workflow syntax @@ -27,12 +29,12 @@ You can configure workflows to run when specific GitHub events occur, at a sched ### Authentication and secrets -{% data variables.product.prodname_dotcom %} provides a token that you can use to authenticate on behalf of {% data variables.product.prodname_actions %}. You can also store sensitive information as a secret in your organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}, repository, or environments{% else %} or repository{% endif %}. {% data variables.product.prodname_dotcom %} encrypts all secrets. +{% data variables.product.prodname_dotcom %} provides a token that you can use to authenticate on behalf of {% data variables.product.prodname_actions %}. You can also store sensitive information as a secret in your organization{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}, repository, or environments{% else %} or repository{% endif %}. {% data variables.product.prodname_dotcom %} encrypts all secrets. {% link_in_list /authentication-in-a-workflow %} {% link_in_list /encrypted-secrets %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ### Environments Workflow jobs can reference environments that have protection rules or environment-specific secrets. @@ -40,12 +42,11 @@ Workflow jobs can reference environments that have protection rules or environme {% link_in_list /environments %} {% endif %} -### {% data variables.product.prodname_dotcom %}-hosted runners +### Environment variables -GitHub offers hosted virtual machines to run workflows. The virtual machine contains an environment with tools, packages, and environment variables for GitHub Actions to use. +{% data variables.product.prodname_dotcom %} sets default environment variables for each {% data variables.product.prodname_actions %} workflow run. You can also set custom environment variables in your workflow file. {% link_in_list /environment-variables %} -{% link_in_list /specifications-for-github-hosted-runners %} {% if currentVersion == "free-pro-team@latest" %} ### Administration diff --git a/content/actions/reference/usage-limits-billing-and-administration.md b/content/actions/reference/usage-limits-billing-and-administration.md index 9029966809cc..c59edbf1010c 100644 --- a/content/actions/reference/usage-limits-billing-and-administration.md +++ b/content/actions/reference/usage-limits-billing-and-administration.md @@ -7,17 +7,19 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About billing for {% data variables.product.prodname_actions %} {% if currentVersion == "free-pro-team@latest" %} {% data reusables.github-actions.actions-billing %} For more information, see "[About billing for {% data variables.product.prodname_actions %}](/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions)." {% else %} -GitHub Actions usage is free for {% data variables.product.prodname_ghe_server %} that use self-hosted runners. +GitHub Actions usage is free for {% data variables.product.prodname_ghe_server %}s that use self-hosted runners. {% endif %} ### Usage limits @@ -53,7 +55,7 @@ Usage limits apply to self-hosted runners. For more information, see "[About sel In addition to the usage limits, you must ensure that you use {% data variables.product.prodname_actions %} within the [GitHub Terms of Service](/articles/github-terms-of-service/). For more information on {% data variables.product.prodname_actions %}-specific terms, see the [GitHub Additional Product Terms](/github/site-policy/github-additional-product-terms#a-actions-usage). {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ### Artifact and log retention policy You can configure the artifact and log retention period for your repository, organization, or enterprise account. @@ -76,7 +78,7 @@ For more information, see: - "[Disabling or limiting {% data variables.product.prodname_actions %} for your organization](/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization)"{% if currentVersion == "free-pro-team@latest" %} - "[Enforcing {% data variables.product.prodname_actions %} policies in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-github-actions-policies-in-your-enterprise-account)" for {% data variables.product.prodname_ghe_cloud %}{% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ### Disabling and enabling workflows You can enable and disable individual workflows in your repository on {% data variables.product.prodname_dotcom %}. diff --git a/content/actions/reference/workflow-commands-for-github-actions.md b/content/actions/reference/workflow-commands-for-github-actions.md index 9ed021e0352e..3c2e13b996d3 100644 --- a/content/actions/reference/workflow-commands-for-github-actions.md +++ b/content/actions/reference/workflow-commands-for-github-actions.md @@ -12,16 +12,18 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About workflow commands Actions can communicate with the runner machine to set environment variables, output values used by other actions, add debug messages to the output logs, and other tasks. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} Most workflow commands use the `echo` command in a specific format, while others are invoked by writing to a file. For more information, see ["Environment files".](#environment-files) {% else %} Workflow commands use the `echo` command in a specific format. @@ -67,11 +69,11 @@ The following table shows which toolkit functions are available within a workflo | Toolkit function | Equivalent workflow command | | ----------------- | ------------- | -| `core.addPath` | {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}Accessible using environment file `GITHUB_PATH`{% else %} `add-path` {% endif %} | +| `core.addPath` | {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}Accessible using environment file `GITHUB_PATH`{% else %} `add-path` {% endif %} | | `core.debug` | `debug` | | `core.error` | `error` | | `core.endGroup` | `endgroup` | -| `core.exportVariable` | {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}Accessible using environment file `GITHUB_ENV`{% else %} `set-env` {% endif %} | +| `core.exportVariable` | {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}Accessible using environment file `GITHUB_ENV`{% else %} `set-env` {% endif %} | | `core.getInput` | Accessible using environment variable `INPUT_{NAME}` | | `core.getState` | Accessible using environment variable `STATE_{NAME}` | | `core.isDebug` | Accessible using environment variable `RUNNER_DEBUG` | @@ -244,7 +246,7 @@ The `STATE_processID` variable is then exclusively available to the cleanup scri console.log("The running PID from the main action is: " + process.env.STATE_processID); ``` -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ## Environment Files During the execution of a workflow, the runner generates temporary files that can be used to perform certain actions. The path to these files are exposed via environment variables. You will need to use UTF-8 encoding when writing to these files to ensure proper processing of the commands. Multiple commands can be written to the same file, separated by newlines. diff --git a/content/actions/reference/workflow-syntax-for-github-actions.md b/content/actions/reference/workflow-syntax-for-github-actions.md index 8ccdc04e3f0d..9883e1bca38e 100644 --- a/content/actions/reference/workflow-syntax-for-github-actions.md +++ b/content/actions/reference/workflow-syntax-for-github-actions.md @@ -10,10 +10,12 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} ### About YAML syntax for workflows @@ -288,6 +290,20 @@ In this example, `job3` uses the `always()` conditional expression so that it al **Required**. The type of machine to run the job on. The machine can be either a {% data variables.product.prodname_dotcom %}-hosted runner or a self-hosted runner. +{% if currentVersion == "github-ae@latest" %} +#### {% data variables.actions.hosted_runner %}s + +If you use an {% data variables.actions.hosted_runner %}, each job runs in a fresh instance of a virtual environment specified by `runs-on`. + +##### Example + +```yaml +runs-on: [AE-runner-for-CI] +``` + +For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)." + +{% else %} {% data reusables.actions.enterprise-github-hosted-runners %} #### {% data variables.product.prodname_dotcom %}-hosted runners @@ -308,9 +324,12 @@ runs-on: ubuntu-latest ``` For more information, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/github/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)." +{% endif %} #### Self-hosted runners +{% data reusables.actions.ae-self-hosted-runners-notice %} + {% data reusables.github-actions.self-hosted-runner-labels-runs-on %} ##### Example @@ -321,7 +340,7 @@ runs-on: [self-hosted, linux] For more information, see "[About self-hosted runners](/github/automating-your-workflow-with-github-actions/about-self-hosted-runners)" and "[Using self-hosted runners in a workflow](/github/automating-your-workflow-with-github-actions/using-self-hosted-runners-in-a-workflow)." -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ### `jobs..environment` The environment that the job references. All environment protection rules must pass before a job referencing the environment is sent to a runner. For more information, see "[Environments](/actions/reference/environments)." @@ -619,6 +638,27 @@ jobs: uses: docker://gcr.io/cloud-builders/gradle ``` +#### Example using action inside a different private repository than the workflow + +Your workflow must checkout the private repository and reference the action locally. + +{% raw %} +```yaml +jobs: + my_first_job: + steps: + - name: Check out repository + uses: actions/checkout@v2 + with: + repository: octocat/my-private-repo + ref: v1.0 + token: ${{ secrets.GITHUB_TOKEN }} + path: ./.github/actions/my-private-repo + - name: Run my action + uses: ./.github/actions/my-private-repo/my-action +``` +{% endraw %} + ### `jobs..steps[*].run` Runs command-line programs using the operating system's shell. If you do not provide a `name`, the step name will default to the text specified in the `run` command. @@ -726,7 +766,13 @@ steps: shell: perl {0} ``` -The command used, `perl` in this example, must be installed on the runner. For information about the software included on GitHub-hosted runners, see "[Specifications for GitHub-hosted runners](/actions/reference/specifications-for-github-hosted-runners#supported-software)." +The command used, `perl` in this example, must be installed on the runner. + + +{% if currentVersion == "github-ae@latest" %}For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} +For information about the software included on GitHub-hosted runners, see "[Specifications for GitHub-hosted runners](/actions/reference/specifications-for-github-hosted-runners#supported-software)." +{% endif %} #### Exit codes and error action preference @@ -897,7 +943,9 @@ steps: ``` {% endraw %} -To find supported configuration options for {% data variables.product.prodname_dotcom %}-hosted runners, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)." +{% if currentVersion == "github-ae@latest" %}To find supported configuration options for {% data variables.actions.hosted_runner %}s, see "[Software specifications](/actions/using-github-hosted-runners/about-ae-hosted-runners#software-specifications)." +{% else %}To find supported configuration options for {% data variables.product.prodname_dotcom %}-hosted runners, see "[Virtual environments for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners)." +{% endif %} #### Example including additional values into combinations @@ -1039,7 +1087,7 @@ jobs: The Docker image to use as the container to run the action. The value can be the Docker Hub image name or a {% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.23" %}public{% endif %} registry name. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ### `jobs..container.credentials` @@ -1123,7 +1171,7 @@ services: The Docker image to use as the service container to run the action. The value can be the Docker Hub image name or a {% if enterpriseServerVersions contains currentVersion and currentVersion ver_lt "enterprise-server@2.23" %}public{% endif %} registry name. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ### `jobs..services..credentials` diff --git a/content/actions/using-github-hosted-runners/about-ae-hosted-runners.md b/content/actions/using-github-hosted-runners/about-ae-hosted-runners.md new file mode 100644 index 000000000000..671310fe96b2 --- /dev/null +++ b/content/actions/using-github-hosted-runners/about-ae-hosted-runners.md @@ -0,0 +1,100 @@ +--- +title: About AE hosted runners +intro: '{% data variables.product.prodname_ghe_managed %} offers customizable and security hardened hosted virtual machines to run {% data variables.product.prodname_actions %} workflows. You can select the hardware, bring your own machine image, and enable an IP address for networking with your {% data variables.actions.hosted_runner %}.' +product: '{% data reusables.gated-features.actions %}' +versions: + github-ae: '*' +--- + + + + +{% data reusables.actions.ae-beta %} + +### About {% data variables.actions.hosted_runner %}s + +An {% data variables.actions.hosted_runner %} is a virtual machine hosted by {% data variables.product.prodname_dotcom %} with the {% data variables.product.prodname_actions %} runner service installed. + +{% data variables.product.prodname_ghe_managed %} lets you create and customize {% data variables.actions.hosted_runner %}s using Ubuntu or Windows images; you can select the size of machine you want and configure security hardened networking for them. {% data variables.actions.hosted_runner %}s are fully managed and auto-scaled by {% data variables.product.prodname_dotcom %}. + +Each workflow job is executed in a fresh instance of the {% data variables.actions.hosted_runner %}, and you can run workflows directly on the virtual machine or in a Docker container. All steps in the job execute in the same instance, allowing the actions in that job to share information using the {% data variables.actions.hosted_runner %}'s filesystem. + +{% note %} +{% data variables.actions.hosted_runner %}s are the only runners available for {% data variables.product.prodname_ghe_managed %}, and self-hosted runners are not available. +{% endnote %} + +To add {% data variables.actions.hosted_runner %}s to your organization or enterprise, see ["Adding {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/adding-ae-hosted-runners)." + + +### Billing + +{% data variables.product.prodname_actions %} is currently in beta for {% data variables.product.prodname_ghe_managed %}. During this beta period, {% data variables.actions.hosted_runner %}s are not billed, and can be used for free. + +Once the beta ends, billed usage will include the full uptime of active instances in your AE hosted runner sets. This includes: +- Job time - minutes spent running Actions job. +- Management - minutes spent re-imaging machines and any idle time created as a result of desired auto-scale behavior. + +Pricing will scale linearly with cores. For example, 4 cores will be twice the price of 2 cores. Windows VMs will be priced higher than Linux VMs. + +### Hardware specifications + +{% data variables.actions.hosted_runner %}s are available on a range of virtual machines hosted in Microsoft Azure. Depending on regional availability, you can choose from `Standard_Das_v4`, `Standard_DS_v2`, `Standard_Fs_v2 series`. Certain regions also include GPU runners based on `Standard_NCs_v3`. + +For more information about these Azure machine resources, see "[Sizes for virtual machines in Azure](https://docs.microsoft.com/en-gb/azure/virtual-machines/sizes)" in the Microsoft Azure documentation. + +To determine which runner executed a job, you can review the workflow logs. For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." + +### Software specifications + +You can use {% data variables.actions.hosted_runner %}s with standard operating system images, or you can add images that you've created. + +#### Default operating system images + +These images only include the standard operating system tools: + +- Ubuntu 18.04 LTS (Canonical) +- Ubuntu 16.04 LTS (Canonical) +- Windows Server 2019 (Microsoft) +- Windows Server 2016 (Microsoft) + +#### Custom operating system images + +You can create your own OS images in Azure and have them added to {% data variables.product.prodname_ghe_managed %} as {% data variables.actions.hosted_runner %}s. For more information, see "[Adding an {% data variables.actions.hosted_runner %} with a custom image"](/actions/using-github-hosted-runners/adding-ae-hosted-runners#adding-an-ae-hosted-runner-with-a-custom-image). + +### Network specifications + +You can optionally enable a fixed static public IP address for your {% data variables.actions.hosted_runner %}s. If enabled, all {% data variables.actions.hosted_runner %}s in your instance will share a range of 2 to 4 IP addresses, and will communicate using ports on those addresses. + +If you don't enable static public IP addresses, then your {% data variables.actions.hosted_runner %}s will subsequently have the same IP address ranges as the Azure datacenters. Inbound ICMP packets are blocked, so `ping` or `traceroute` commands are not expected to work. + +To get a list of IP address ranges that {% data variables.product.prodname_actions %} uses for {% data variables.actions.hosted_runner %}s, you can use the {% data variables.product.prodname_dotcom %} REST API . For more information, see the `actions` key in the response of the "[Get GitHub meta information](/rest/reference/meta#get-github-meta-information)" endpoint. You can use this list of IP addresses if you require an allow-list to prevent unauthorized access to your internal resources. + +The list of {% data variables.product.prodname_actions %} IP addresses returned by the API is updated once a week. + +### Administrative privileges for {% data variables.actions.hosted_runner %}s + +The Linux virtual machines run using passwordless `sudo`. When you need to execute commands or install tools that require more privileges than the current user, you can use `sudo` without needing to provide a password. For more information, see the "[Sudo Manual](https://www.sudo.ws/man/1.8.27/sudo.man.html)." + +Windows virtual machines are configured to run as administrators with User Account Control (UAC) disabled. For more information, see "[How User Account Control works](https://docs.microsoft.com/windows/security/identity-protection/user-account-control/how-user-account-control-works)" in the Windows documentation. + +### File systems + +{% data variables.product.prodname_dotcom %} executes actions and shell commands in specific directories on the virtual machine. The file paths on virtual machines are not static. Use the environment variables {% data variables.product.prodname_dotcom %} provides to construct file paths for the `home`, `workspace`, and `workflow` directories. + +| Directory | Environment variable | Description | +|-----------|----------------------|-------------| +| `home` | `HOME` | Contains user-related data. For example, this directory could contain credentials from a login attempt. | +| `workspace` | `GITHUB_WORKSPACE` | Actions and shell commands execute in this directory. An action can modify the contents of this directory, which subsequent actions can access. | +| `workflow/event.json` | `GITHUB_EVENT_PATH` | The `POST` payload of the webhook event that triggered the workflow. {% data variables.product.prodname_dotcom %} rewrites this each time an action executes to isolate file content between actions. + +For a list of the environment variables {% data variables.product.prodname_dotcom %} creates for each workflow, see "[Using environment variables](/github/automating-your-workflow-with-github-actions/using-environment-variables)." + +#### Docker container filesystem + +Actions that run in Docker containers have static directories under the `/github` path. However, we strongly recommend using the default environment variables to construct file paths in Docker containers. + +{% data variables.product.prodname_dotcom %} reserves the `/github` path prefix and creates three directories for actions. + +- `/github/home` +- `/github/workspace` - {% data reusables.repositories.action-root-user-required %} +- `/github/workflow` diff --git a/content/actions/reference/specifications-for-github-hosted-runners.md b/content/actions/using-github-hosted-runners/about-github-hosted-runners.md similarity index 95% rename from content/actions/reference/specifications-for-github-hosted-runners.md rename to content/actions/using-github-hosted-runners/about-github-hosted-runners.md index 77dcfae8a3c8..bbcebb10c5a3 100644 --- a/content/actions/reference/specifications-for-github-hosted-runners.md +++ b/content/actions/using-github-hosted-runners/about-github-hosted-runners.md @@ -1,5 +1,5 @@ --- -title: Specifications for GitHub-hosted runners +title: About GitHub-hosted runners intro: '{% data variables.product.prodname_dotcom %} offers hosted virtual machines to run workflows. The virtual machine contains an environment of tools, packages, and settings available for {% data variables.product.prodname_actions %} to use.' product: '{% data reusables.gated-features.actions %}' redirect_from: @@ -9,6 +9,7 @@ redirect_from: - /actions/automating-your-workflow-with-github-actions/virtual-environments-for-github-hosted-runners - /actions/reference/virtual-environments-for-github-hosted-runners - /actions/reference/software-installed-on-github-hosted-runners + - /actions/reference/specifications-for-github-hosted-runners versions: free-pro-team: '*' enterprise-server: '>=2.22' @@ -61,24 +62,26 @@ Workflow logs list the runner used to run a job. For more information, see "[Vie ### Supported software -The software tools included in {% data variables.product.prodname_dotcom %}-hosted runners are updated weekly. For the latest list of included tools for each runner operating system, see the links below: +The software tools included in {% data variables.product.prodname_dotcom %}-hosted runners are updated weekly. The update process takes several days, and the list of preinstalled software on the `main` branch is updated after the whole deployment ends. +#### Preinstalled software + +Workflow logs include a link to the preinstalled tools on the exact runner. To find this information in the workflow log, expand the `Set up job` section. Under that section, expand the `Virtual Environment` section. The link following `Included Software` will tell you the the preinstalled tools on the runner that ran the workflow. +![Installed software link](/assets/images/actions-runner-installed-software-link.png) +For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." + +For the overall list of included tools for each runner operating system, see the links below: * [Ubuntu 20.04 LTS](https://github.com/actions/virtual-environments/blob/main/images/linux/Ubuntu2004-README.md) * [Ubuntu 18.04 LTS](https://github.com/actions/virtual-environments/blob/main/images/linux/Ubuntu1804-README.md) * [Ubuntu 16.04 LTS](https://github.com/actions/virtual-environments/blob/main/images/linux/Ubuntu1604-README.md) * [Windows Server 2019](https://github.com/actions/virtual-environments/blob/main/images/win/Windows2019-Readme.md) * [Windows Server 2016](https://github.com/actions/virtual-environments/blob/main/images/win/Windows2016-Readme.md) -* [macOS 10.15](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-10.15-Readme.md) * [macOS 11.0](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-11.0-Readme.md) - -{% data reusables.github-actions.ubuntu-runner-preview %} -{% data reusables.github-actions.macos-runner-preview %} +* [macOS 10.15](https://github.com/actions/virtual-environments/blob/main/images/macos/macos-10.15-Readme.md) {% data variables.product.prodname_dotcom %}-hosted runners include the operating system's default built-in tools, in addition to the packages listed in the above references. For example, Ubuntu and macOS runners include `grep`, `find`, and `which`, among other default tools. -Workflow logs include a link to the preinstalled tools on the exact runner. To find this information in the workflow log, expand the `Set up job` section. Under that section, expand the `Virtual Environment` section. The link following `Included Software` will tell you the the preinstalled tools on the runner that ran the workflow. -![Installed software link](/assets/images/actions-runner-installed-software-link.png) -For more information, see "[Viewing workflow run history](/actions/managing-workflow-runs/viewing-workflow-run-history)." +#### Using preinstalled software We recommend using actions to interact with the software installed on runners. This approach has several benefits: - Usually, actions provide more flexible functionality like versions selection, ability to pass arguments, and parameters diff --git a/content/actions/using-github-hosted-runners/adding-ae-hosted-runners.md b/content/actions/using-github-hosted-runners/adding-ae-hosted-runners.md new file mode 100644 index 000000000000..bd36ee97ccca --- /dev/null +++ b/content/actions/using-github-hosted-runners/adding-ae-hosted-runners.md @@ -0,0 +1,45 @@ +--- +title: Adding AE hosted runners +intro: 'You can add an {% data variables.actions.hosted_runner %} to an organization or an enterprise.' +versions: + github-ae: '*' +--- + +{% data reusables.actions.ae-beta %} + +{% note %} + +**Note:** To add {% data variables.actions.hosted_runner %}s to {% data variables.product.prodname_ghe_managed %}, you will need to contact {% data variables.product.prodname_dotcom %} support. This article describes the information that support will need in order to complete this process. + +{% endnote %} + +{% data variables.actions.hosted_runner %}s can use the base Azure operating system images, or you can create your own custom images. + +### Adding an {% data variables.actions.hosted_runner %} from the base Azure image + +You can add {% data variables.actions.hosted_runner %}s that use the base Azure operating system images. +To add {% data variables.actions.hosted_runner %}s to your organization or enterprise, contact {% data variables.product.prodname_dotcom %} support and have the following information ready: + - Required operating system: Available options are listed at ["Software specifications](/actions/using-github-hosted-runners/about-ae-hosted-runners#software-specifications)." + - Choose a name for each pool of {% data variables.actions.hosted_runner %}s. These names are created as labels, allowing you to route your workflows to these runners. For more information, see ["Using {% data variables.actions.hosted_runner %}s in a workflow](/actions/using-github-hosted-runners/using-ae-hosted-runners-in-a-workflow)." + - Where to add the {% data variables.actions.hosted_runner %}: Identify the names of the organizations and enterprises that will receive the runners. + +### Adding an {% data variables.actions.hosted_runner %} with a custom image + +To create a custom operating system image, see the steps at ["Creating custom images"](/actions/using-github-hosted-runners/creating-custom-images). + +Once you've created a custom image using the above steps, contact {% data variables.product.prodname_dotcom %} support and provide the following details: + + - The SAS URI you generated when following the custom image creation steps. + - Type of operating system used by the image: This can be Linux or Windows. + - Image name. + - Version. + - VM SKU for the new pool. + - Choose a name for each pool of {% data variables.actions.hosted_runner %}s. These names are created as labels, allowing you to route your workflows to these runners. For more information, see ["Using {% data variables.actions.hosted_runner %}s in a workflow](/actions/using-github-hosted-runners/using-ae-hosted-runners-in-a-workflow)." + - Where to add the {% data variables.actions.hosted_runner %}: Identify the names of the organizations and enterprises that will receive the runners. + +### Reviewing your {% data variables.actions.hosted_runner %}s + +Once your runners have been added by {% data variables.product.prodname_dotcom %} support, you'll be able to find them in your list of runners: + +{% data reusables.github-actions.hosted-runner-navigate-to-repo-org-enterprise %} +{% data reusables.github-actions.hosted-runner-list %} diff --git a/content/actions/using-github-hosted-runners/creating-custom-images.md b/content/actions/using-github-hosted-runners/creating-custom-images.md new file mode 100644 index 000000000000..b1ea396386b1 --- /dev/null +++ b/content/actions/using-github-hosted-runners/creating-custom-images.md @@ -0,0 +1,52 @@ +--- +title: Creating custom images +intro: 'You can create custom images for {% data variables.actions.hosted_runner %}s.' +versions: + github-ae: '*' +--- + +{% data reusables.actions.ae-beta %} + +### Creating an {% data variables.actions.hosted_runner %} with a custom image + +{% data variables.actions.hosted_runner %}s can use operating system images that you've customized to suit your needs. This article includes the high level steps for creating the image in Azure and preparing it for {% data variables.product.prodname_ghe_managed %}. For more information, refer to [the Azure documentation](https://docs.microsoft.com/en-us/azure/virtual-machines/). + +During this beta, to be able to create a custom image for {% data variables.actions.hosted_runner %}s, you will need an Azure subscription that is able to provision a virtual machine. + + +1. Provision a new VM in your tenant using a marketplace image or a virtual hard drive(VHD). +2. Optionally, install your required software on the VM. +3. Deprovision the VM: + - For Linux: `ssh` to the VM and run: + ```sh + $ sudo waagent -deprovision+user + ``` + - For Windows: Follow the steps described at ["Generalize the source VM by using Sysprep](https://docs.microsoft.com/en-us/azure/virtual-machines/windows/upload-generalized-managed#generalize-the-source-vm-by-using-sysprep)." + +4. Use the Azure CLI to deallocate and generalize the VM: + ```powershell + $resourceGroupName = "octocat-testgroup" + $vmName = "octo-vm" + + Stop-AzVM -ResourceGroupName $resourceGroupName -Name $vmName + Set-AzVM -ResourceGroupName $resourceGroupName -Name $vmName -Generalized + ``` + - Replace `octo-vm` with the name of your virtual machine. + - For more information regarding these steps, see "[How to create a managed image of a virtual machine or VHD](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image#step-1-deprovision-the-vm)." +5. Generate a SAS URI for the VM's operating system disk. + - Using the Azure Portal: On the disk resource, navigate to **Disk Export**, set `URL expires in (seconds)` to `86400` (24 hours), and generate the URL. + - Using the Azure CLI: + ```powershell + $resourceGroupName = "octocat-testgroup" + $vmName = "octo-vm" + + $vm = Get-AzVM -ResourceGroupName $resourceGroupName -Name $vmName + Grant-AzDiskAccess ` + -ResourceGroupName $resourceGroupName ` + -DiskName $vm.StorageProfile.OsDisk.Name ` + -Access Read ` + -DurationInSecond 86400 + ``` + - Replace `octo-vm` with the name of your virtual machine. + +Once you've created the image, you can have it added to {% data variables.product.prodname_ghe_managed %}. For more information, see ["Adding an {% data variables.actions.hosted_runner %} with a custom image"](/actions/using-github-hosted-runners/adding-ae-hosted-runners#adding-an-ae-hosted-runner-with-a-custom-image). diff --git a/content/actions/using-github-hosted-runners/index.md b/content/actions/using-github-hosted-runners/index.md new file mode 100644 index 000000000000..681269a25393 --- /dev/null +++ b/content/actions/using-github-hosted-runners/index.md @@ -0,0 +1,19 @@ +--- +title: Using GitHub-hosted runners +intro: You can use GitHub's runners to execute your GitHub Actions workflows. +versions: + free-pro-team: '*' + enterprise-server: '>=2.22' + github-ae: '*' +--- + +{% data reusables.actions.enterprise-beta %} +{% data reusables.actions.enterprise-github-hosted-runners %} + +{% link_in_list /about-github-hosted-runners %} +{% link_in_list /about-ae-hosted-runners %} +{% link_in_list /adding-ae-hosted-runners %} +{% link_in_list /using-ae-hosted-runners-in-a-workflow %} +{% link_in_list /using-labels-with-ae-hosted-runners %} +{% link_in_list /using-groups-to-manage-access-to-ae-hosted-runners %} +{% link_in_list /creating-custom-images %} diff --git a/content/actions/using-github-hosted-runners/using-ae-hosted-runners-in-a-workflow.md b/content/actions/using-github-hosted-runners/using-ae-hosted-runners-in-a-workflow.md new file mode 100644 index 000000000000..8dbbb95ebe92 --- /dev/null +++ b/content/actions/using-github-hosted-runners/using-ae-hosted-runners-in-a-workflow.md @@ -0,0 +1,38 @@ +--- +title: Using AE hosted runners in a workflow +intro: 'You can use labels to send jobs to a pool of {% data variables.actions.hosted_runner %}s.' +versions: + github-ae: '*' +--- + +{% data reusables.actions.ae-beta %} + +### Using {% data variables.actions.hosted_runner %}s in a workflow + +Labels allow you to send workflow jobs to any {% data variables.actions.hosted_runner %} that includes that label. You can use the default labels, and you can create your own custom labels. + +### Using default labels to route jobs + +An {% data variables.actions.hosted_runner %} receives a label when it is added to {% data variables.product.prodname_actions %}. The label is used to indicate where it was assigned. + +You can use your workflow's YAML to send jobs to a specific {% data variables.actions.hosted_runner %} pool. This example demonstrates how to configure a workflow to run on a label called `AE-runner-for-CI`: + +```yaml +runs-on: [AE-runner-for-CI] +``` + +For more information, see "[Workflow syntax for {% data variables.product.prodname_actions %}](/github/automating-your-workflow-with-github-actions/workflow-syntax-for-github-actions#jobsjob_idruns-on)." + +### Using custom labels to route jobs + +You can create custom labels and assign them to your {% data variables.actions.hosted_runner %}s at any time. Custom labels let you send jobs to particular types of runners, based on how they're labeled. + +For example, if you have a job that requires a specific software package, you can create a custom label called `octocat` and assign it to the runners that have the package installed. An {% data variables.actions.hosted_runner %} that matches all the assigned labels will then be eligible to run the job. + +This example shows a job that uses multiple labels: + +```yaml +runs-on: [AE-runner-for-CI, octocat, linux] +``` + +These labels operate cumulatively, so an {% data variables.actions.hosted_runner %}'s labels must match all of them for it to be eligible to process the job. diff --git a/content/actions/using-github-hosted-runners/using-groups-to-manage-access-to-ae-hosted-runners.md b/content/actions/using-github-hosted-runners/using-groups-to-manage-access-to-ae-hosted-runners.md new file mode 100644 index 000000000000..0ba75bac96a8 --- /dev/null +++ b/content/actions/using-github-hosted-runners/using-groups-to-manage-access-to-ae-hosted-runners.md @@ -0,0 +1,91 @@ +--- +title: Using groups to manage access to AE hosted runners +intro: You can use policies to limit access to {% data variables.actions.hosted_runner %}s that have been added to an organization or enterprise. +versions: + github-ae: '*' +--- + +{% data reusables.actions.ae-beta %} + +### About {% data variables.actions.hosted_runner %} groups + +{% data variables.actions.hosted_runner %} groups are used to control access to {% data variables.actions.hosted_runner %}s at the organization and enterprise level. Enterprise admins can configure access policies that control which organizations in an enterprise have access to the runner group. Organization admins can configure access policies that control which repositories in an organization have access to the runner group. + +When an enterprise admin grants an organization access to a runner group, organization admins can see the runner group listed in the organization's {% data variables.actions.hosted_runner %} settings. The organizations admins can then assign additional granular repository access policies to the enterprise runner group. + +When new runners are created, they are automatically assigned to the default group. Runners can only be in one group at a time. You can move runners from the default group to another group. For more information, see "[Moving an {% data variables.actions.hosted_runner %} to a group](#moving-an-ae-hosted-runner-to-a-group)." + +### Creating an {% data variables.actions.hosted_runner %} group for an organization + +All organizations have a single default {% data variables.actions.hosted_runner %} group. Organizations within an enterprise account can create additional runner groups. Organization admins can allow individual repositories access to a runner group. + +{% data variables.actions.hosted_runner %}s are automatically assigned to the default group when created, and can only be members of one group at a time. You can move a runner from the default group to any group you create. + +When creating a group, you must choose a policy that defines which repositories have access to the runner group. + +{% data reusables.organizations.navigate-to-org %} +{% data reusables.organizations.org_settings %} +{% data reusables.organizations.settings-sidebar-actions %} +1. In the **Self-hosted runners** section, click **Add new**, and then **New group**. + + ![Add runner group](/assets/images/help/settings/actions-hosted-runner-add-new-group.png) + +1. Enter a name for your runner group, and assign a policy for repository access. + + You can configure a runner group to be accessible to a specific list of repositories, or to all repositories in the organization. By default, only private repositories can access runners in a runner group, but you can override this. + ![Add runner group options](/assets/images/help/settings/actions-org-add-runner-group-options.png) + +1. Click **Save group** to create the group and apply the policy. + +### Creating an {% data variables.actions.hosted_runner %} group for an enterprise + +Enterprises can add their {% data variables.actions.hosted_runner %}s to groups for access management. Enterprises can create groups of {% data variables.actions.hosted_runner %}s that are accessible to specific organizations in the enterprise account. Organization admins can then assign additional granular repository access policies to the enterprise runner groups. + +{% data variables.actions.hosted_runner %}s are automatically assigned to the default group when created, and can only be members of one group at a time. You can assign the runner to a specific group during the registration process, or you can later move the runner from the default group to a custom group. + +When creating a group, you must choose a policy that defines which organizations have access to the runner group. + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.policies-tab %} +{% data reusables.enterprise-accounts.actions-tab %} +1. Click the **Self-hosted runners** tab. +1. Click **Add new**, and then **New group**. + + ![Add runner group](/assets/images/help/settings/actions-hosted-runner-add-new-group.png) + +1. Enter a name for your runner group, and assign a policy for organization access. + + You can configure a runner group to be accessible to a specific list of organizations, or all organizations in the enterprise. By default, only private repositories can access runners in a runner group, but you can override this. + ![Add runner group options](/assets/images/help/settings/actions-enterprise-account-add-runner-group-options.png) + +1. Click **Save group** to create the group and apply the policy. + +### Changing the access policy of an {% data variables.actions.hosted_runner %} group + +You can update the access policy of a runner group, or rename a runner group. + +{% data reusables.github-actions.hosted-runner-configure-runner-group-access %} + +### Moving an {% data variables.actions.hosted_runner %} to a group + +New {% data variables.actions.hosted_runner %}s are automatically assigned to the default group, and can then be moved to another group. + +1. In the **Self-hosted runners** section of the settings page, locate the current group of the runner you want to move and expand the list of group members. +![View runner group members](/assets/images/help/settings/actions-hosted-runner-group-members.png) +1. Select the checkbox next to the runner, and then click **Move to group** to see the available destinations. +![Runner group member move](/assets/images/help/settings/actions-hosted-runner-group-member-move.png) +1. To move the runner, click on the destination group. +![Runner group member move](/assets/images/help/settings/actions-hosted-runner-group-member-move-destination.png) + +### Removing an {% data variables.actions.hosted_runner %} group + +{% data variables.actions.hosted_runner %}s are automatically returned to the default group when their group is removed. + +1. In the **Self-hosted runners** section of the settings page, locate the group you want to delete, and click the {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} button. + ![View runner group settings](/assets/images/help/settings/actions-hosted-runner-group-kebab.png) + +1. To remove the group, click **Remove group**. + + ![View runner group settings](/assets/images/help/settings/actions-hosted-runner-group-remove.png) + +1. Review the confirmation prompts, and click **Remove this runner group**. diff --git a/content/actions/using-github-hosted-runners/using-labels-with-ae-hosted-runners.md b/content/actions/using-github-hosted-runners/using-labels-with-ae-hosted-runners.md new file mode 100644 index 000000000000..9fdd1f63c4b6 --- /dev/null +++ b/content/actions/using-github-hosted-runners/using-labels-with-ae-hosted-runners.md @@ -0,0 +1,25 @@ +--- +title: Using labels with AE hosted runners +intro: You can use labels to organize your {% data variables.actions.hosted_runner %}s based on their characteristics. +versions: + github-ae: '*' +--- + +{% data reusables.actions.ae-beta %} + +For information on how to use labels to route jobs to specific types of {% data variables.actions.hosted_runner %}s, see "[Using {% data variables.actions.hosted_runner %}s in a workflow](/actions/using-github-hosted-runners/using-ae-hosted-runners-in-a-workflow)." + + +{% note %} + +**Note:** To manage labels for your {% data variables.actions.hosted_runner %}s, you will need to contact {% data variables.product.prodname_dotcom %} support. + +{% endnote %} + +### Viewing the labels for your {% data variables.actions.hosted_runner %}s +{% data reusables.github-actions.hosted-runner-navigate-to-repo-org-enterprise %} +{% data reusables.github-actions.hosted-runner-list %} +{% data reusables.github-actions.hosted-runner-list-group %} +1. Locate the runner you want to check, and click {% octicon "triangle-down" aria-label="The downward triangle" %} to view the label selection menu. Labels already assigned to your runner have a {% octicon "check" aria-label="Check mark" %} next to them. + +![Change runner label](/assets/images/help/settings/actions-hosted-runner-list-label.png) diff --git a/content/admin/authentication/about-identity-and-access-management-for-your-enterprise.md b/content/admin/authentication/about-identity-and-access-management-for-your-enterprise.md index 018ebf2daff9..b6075d53221b 100644 --- a/content/admin/authentication/about-identity-and-access-management-for-your-enterprise.md +++ b/content/admin/authentication/about-identity-and-access-management-for-your-enterprise.md @@ -13,7 +13,7 @@ versions: {% data reusables.saml.ae-uses-saml-sso %} {% data reusables.saml.ae-enable-saml-sso-during-bootstrapping %} -After you configure the application for {% data variables.product.product_name %} on your IdP, you can grant access to {% data variables.product.product_location %} by assigning the application to users on your IdP. For more information about SAML SSO for {% data variables.product.product_name %}, see "[Configuring SAML single sign-on for your enterprise](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise)." +After you configure the application for {% data variables.product.product_name %} on your IdP, you can grant access to {% data variables.product.product_location %} by assigning the application to users and groups on your IdP. For more information about SAML SSO for {% data variables.product.product_name %}, see "[Configuring SAML single sign-on for your enterprise](/admin/authentication/configuring-saml-single-sign-on-for-your-enterprise)." {% data reusables.scim.after-you-configure-saml %} For more information, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise)." @@ -25,3 +25,4 @@ To learn how to configure both authentication and user provisioning for {% data - [SAML Wiki](https://wiki.oasis-open.org/security) on the OASIS website - [System for Cross-domain Identity Management: Protocol (RFC 7644)](https://tools.ietf.org/html/rfc7644) on the IETF website +- [Restricting network traffic to your enterprise](/admin/configuration/restricting-network-traffic-to-your-enterprise) diff --git a/content/admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md b/content/admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md index 7af09e12dc3e..a4c079661124 100644 --- a/content/admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md +++ b/content/admin/authentication/configuring-authentication-and-provisioning-for-your-enterprise-using-azure-ad.md @@ -12,9 +12,16 @@ versions: Azure Active Directory (Azure AD) is a service from Microsoft that allows you to centrally manage user accounts and access to web applications. For more information, see [What is Azure Active Directory?](https://docs.microsoft.com/azure/active-directory/fundamentals/active-directory-whatis) in the Microsoft Docs. -To manage identity and access for {% data variables.product.product_name %}, you can use an Azure AD tenant as a SAML IdP for authentication. You can also configure Azure AD to automatically provision accounts and access with SCIM. This configuration allows you to assign or unassign the {% data variables.product.prodname_ghe_managed %} application for a user account in your Azure AD tenant to automatically create, grant access to, or deactivate a corresponding user account on {% data variables.product.product_name %}. +To manage identity and access for {% data variables.product.product_name %}, you can use an Azure AD tenant as a SAML IdP for authentication. You can also configure Azure AD to automatically provision accounts and access membership with SCIM, which allows you to create {% data variables.product.prodname_ghe_managed %} users and manage team and organization membership from your Azure AD tenant. -For more information about managing identity and access for your enterprise on {% data variables.product.product_location %}, see "[Managing identity and access for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise)." +After you enable SAML SSO and SCIM for {% data variables.product.prodname_ghe_managed %} using Azure AD, you can accomplish the following from your Azure AD tenant. + +* Assign the {% data variables.product.prodname_ghe_managed %} application on Azure AD to a user account to automatically create and grant access to a corresponding user account on {% data variables.product.product_name %}. +* Unassign the {% data variables.product.prodname_ghe_managed %} application to a user account on Azure AD to deactivate the corresponding user account on {% data variables.product.product_name %}. +* Assign the {% data variables.product.prodname_ghe_managed %} application to an IdP group on Azure AD to automatically create and grant access to user accounts on {% data variables.product.product_name %} for all members of the IdP group. In addition, the IdP group is available on {% data variables.product.prodname_ghe_managed %} for connection to a team and its parent organization. +* Unassign the {% data variables.product.prodname_ghe_managed %} application from an IdP group to deactivate the {% data variables.product.product_name %} user accounts of all IdP users who had access only through that IdP group and remove the users from the parent organization. The IdP group will be disconnected from any teams on {% data variables.product.product_name %}. + +For more information about managing identity and access for your enterprise on {% data variables.product.product_location %}, see "[Managing identity and access for your enterprise](/admin/authentication/managing-identity-and-access-for-your-enterprise)." For more information about synchronizing teams with IdP groups, see "[Synchronizing a team with an identity provider group](/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group)." ### Prerequisites diff --git a/content/admin/authentication/configuring-user-provisioning-for-your-enterprise.md b/content/admin/authentication/configuring-user-provisioning-for-your-enterprise.md index 5801f401ddd2..a0bd00828514 100644 --- a/content/admin/authentication/configuring-user-provisioning-for-your-enterprise.md +++ b/content/admin/authentication/configuring-user-provisioning-for-your-enterprise.md @@ -28,6 +28,8 @@ The provisioning application on your IdP communicates with {% data variables.pro {% data reusables.scim.supported-idps %} +When you set up user provisioning with a supported IdP, you can also assign or unassign the application for {% data variables.product.product_name %} to groups of users. These groups are then available to organization owners and team maintainers in {% data variables.product.product_location %} to map to {% data variables.product.product_name %} teams. For more information, see "[Synchronizing a team with an identity provider group](/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group)." + ### Prerequisites {% if currentVersion == "github-ae@latest" %} diff --git a/content/admin/configuration/accessing-the-management-console.md b/content/admin/configuration/accessing-the-management-console.md index b107ad6dbc87..94a312d87735 100644 --- a/content/admin/configuration/accessing-the-management-console.md +++ b/content/admin/configuration/accessing-the-management-console.md @@ -19,7 +19,7 @@ versions: Use the {% data variables.enterprise.management_console %} for basic administrative activities: - **Initial setup**: Walk through the initial setup process when first launching {% data variables.product.product_location %} by visiting {% data variables.product.product_location %}'s IP address in your browser. - **Configuring basic settings for your instance**: Configure DNS, hostname, SSL, user authentication, email, monitoring services, and log forwarding on the Settings page. -- **Scheduling maintenance windows**: Take your {% data variables.product.product_location %} offline while performing maintenance using the {% data variables.enterprise.management_console %} or administrative shell. +- **Scheduling maintenance windows**: Take {% data variables.product.product_location %} offline while performing maintenance using the {% data variables.enterprise.management_console %} or administrative shell. - **Troubleshooting**: Generate a support bundle or view high level diagnostic information. - **License management**: View or update your {% data variables.product.prodname_enterprise %} license. diff --git a/content/admin/configuration/command-line-utilities.md b/content/admin/configuration/command-line-utilities.md index 188d0e493655..d10388e2f96f 100644 --- a/content/admin/configuration/command-line-utilities.md +++ b/content/admin/configuration/command-line-utilities.md @@ -209,7 +209,7 @@ You can use these options with the utility: This utility cannot promote a non-site admin to be an owner of all organizations. You can promote an ordinary user account to a site admin with [ghe-user-promote](#ghe-user-promote). -Give organization owner privileges in a specific organization to a single user +Give organization owner privileges in a specific organization to a specific site admin ```shell ghe-org-admin-promote -u USERNAME -o ORGANIZATION diff --git a/content/admin/configuration/configuring-email-for-notifications.md b/content/admin/configuration/configuring-email-for-notifications.md index cc3aac5d7c20..665d0177ca72 100644 --- a/content/admin/configuration/configuring-email-for-notifications.md +++ b/content/admin/configuration/configuring-email-for-notifications.md @@ -1,33 +1,23 @@ --- title: Configuring email for notifications +intro: To make it easy for users to respond quickly to activity on {% data variables.product.product_name %}, you can configure {% data variables.product.product_location %} to send email notifications for issue, pull request, and commit comments. redirect_from: - /enterprise/admin/guides/installation/email-configuration/ - /enterprise/admin/articles/configuring-email/ - /enterprise/admin/articles/troubleshooting-email/ - /enterprise/admin/articles/email-configuration-and-troubleshooting/ - /enterprise/admin/user-management/configuring-email-for-notifications -intro: 'To make it easy for users to respond quickly to activity on {% data variables.product.product_name %}, you can configure your enterprise to send email notifications on issue, pull request, and commit comments{% if enterpriseServerVersions contains currentVersion %}, as well as additional settings to allow inbound email replies{% endif %}.' versions: enterprise-server: '*' github-ae: '*' --- -Notification emails are sent if there is activity on a repository a user is watching, if there is activity in a pull request or issue they are participating in, or if the user or team they're a member of are @mentioned in a comment. - {% if currentVersion == "github-ae@latest" %} -Your dedicated technical account manager in {% data variables.contact.github_support %} can configure email for notifications to be sent through your SMTP server. Make sure you include the following details in your support request. - -- Your SMTP server address -- Login information to authenticate to the server: username and password -- The port your SMTP server uses to send email -- The domain name that your SMTP server will send with a HELO response, if any -- The type of encryption used by your SMTP server -- The no-reply email address to use in the `From` and `To` field for all notifications - -For more information about contacting support, see "[About {% data variables.contact.enterprise_support %}](/enterprise/admin/guides/enterprise-support/about-github-enterprise-support)." -{% else %} -### Configuring SMTP +Enterprise owners can configure email for notifications. +{% endif %} +### Configuring SMTP for your enterprise +{% if enterpriseServerVersions contains currentVersion %} {% data reusables.enterprise_site_admin_settings.access-settings %} {% data reusables.enterprise_site_admin_settings.management-console %} 2. At the top of the page, click **Settings**. @@ -37,32 +27,42 @@ For more information about contacting support, see "[About {% data variables.con 4. Select **Enable email**. This will enable both outbound and inbound email, however for inbound email to work you will also need to configure your DNS settings as described below in "[Configuring DNS and firewall settings to allow incoming emails](#configuring-dns-and-firewall-settings-to-allow-incoming-emails)." ![Enable outbound email](/assets/images/enterprise/management-console/enable-outbound-email.png) -5. Fill in your email server settings: - - In the **Server address** field, type the address of your SMTP server. - - In the **Port** field, type the port that your SMTP server uses to send email. - - In the **Domain** field, type the domain name that your SMTP server will send with a HELO response, if any. - - In the **Authentication** dropdown, choose the type of encryption used by your SMTP server. - - In the **No-reply email address** field, type the email address to use in the From and To fields for all notification emails. - +5. Type the settings for your SMTP server. + - In the **Server address** field, type the address of your SMTP server. + - In the **Port** field, type the port that your SMTP server uses to send email. + - In the **Domain** field, type the domain name that your SMTP server will send with a HELO response, if any. + - Select the **Authentication** dropdown, and choose the type of encryption used by your SMTP server. + - In the **No-reply email address** field, type the email address to use in the From and To fields for all notification emails. 6. If you want to discard all incoming emails that are addressed to the no-reply email address, select **Discard email addressed to the no-reply email address**. ![Checkbox to discard emails addressed to the no-reply email address](/assets/images/enterprise/management-console/discard-noreply-emails.png) -7. Under **Support**, choose a type of link to offer additional support to your users: +7. Under **Support**, choose a type of link to offer additional support to your users. - **Email:** An internal email address. - **URL:** A link to an internal support site. You must include either `http://` or `https://`. ![Support email or URL](/assets/images/enterprise/management-console/support-email-url.png) 8. [Test email delivery](#testing-email-delivery). +{% elsif currentVersion == "github-ae@latest" %} +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.email-tab %} +2. Select **Enable email**. + !["Enable" checkbox for email settings configuration](/assets/images/enterprise/configuration/ae-enable-email-configure.png) +3. Type the settings for your email server. + - In the **Server address** field, type the address of your SMTP server. + - In the **Port** field, type the port that your SMTP server uses to send email. + - In the **Domain** field, type the domain name that your SMTP server will send with a HELO response, if any. + - Select the **Authentication** dropdown, and choose the type of encryption used by your SMTP server. + - In the **No-reply email address** field, type the email address to use in the From and To fields for all notification emails. +4. If you want to discard all incoming emails that are addressed to the no-reply email address, select **Discard email addressed to the no-reply email address**. + !["Discard" checkbox for email settings configuration](/assets/images/enterprise/configuration/ae-discard-email.png) +5. Click **Test email settings**. + !["Test email settings" button for email settings configuration](/assets/images/enterprise/configuration/ae-test-email.png) +6. Under "Send test email to," type the email address where you want to send a test email, then click **Send test email**. + !["Send test email" button for email settings configuration](/assets/images/enterprise/configuration/ae-send-test-email.png) +7. Click **Save**. + !["Save" button for enterprise support contact configuration](/assets/images/enterprise/configuration/ae-save.png) +{% endif %} -### Configuring DNS and firewall settings to allow incoming emails - -If you want to allow email replies to notifications, you must configure your DNS settings. - -1. Ensure that port 25 on the instance is accessible to your SMTP server. -2. Create an A record that points to `reply.[hostname]`. Depending on your DNS provider and instance host configuration, you may be able to instead create a single A record that points to `*.[hostname]`. -3. Create an MX record that points to `reply.[hostname]` so that emails to that domain are routed to the instance. -4. Create an MX record that points `noreply.[hostname]` to `[hostname]` so that replies to the `cc` address in notification emails are routed to the instance. For more information, see {% if currentVersion ver_gt "enterprise-server@2.20" %}"[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications){% else %}"[About email notifications](/github/receiving-notifications-about-activity-on-github/about-email-notifications){% endif %}." - -With your DNS configuration setup, you can now test whether the setup works. - +{% if enterpriseServerVersions contains currentVersion %} ### Testing email delivery 1. At the top of the **Email** section, click **Test email settings**. @@ -84,6 +84,15 @@ With your DNS configuration setup, you can now test whether the setup works. 6. Wait for the configuration run to complete. ![Configuring your instance](/assets/images/enterprise/management-console/configuration-run.png) +### Configuring DNS and firewall settings to allow incoming emails + +If you want to allow email replies to notifications, you must configure your DNS settings. + +1. Ensure that port 25 on the instance is accessible to your SMTP server. +2. Create an A record that points to `reply.[hostname]`. Depending on your DNS provider and instance host configuration, you may be able to instead create a single A record that points to `*.[hostname]`. +3. Create an MX record that points to `reply.[hostname]` so that emails to that domain are routed to the instance. +4. Create an MX record that points `noreply.[hostname]` to `[hostname]` so that replies to the `cc` address in notification emails are routed to the instance. For more information, see {% if currentVersion ver_gt "enterprise-server@2.20" %}"[Configuring notifications](/github/managing-subscriptions-and-notifications-on-github/configuring-notifications){% else %}"[About email notifications](/github/receiving-notifications-about-activity-on-github/about-email-notifications){% endif %}." + ### Troubleshooting email delivery #### Create a Support Bundle @@ -155,7 +164,7 @@ Note that the client first connects; then, the queue becomes active. Then, the m [2014-10-30T00:47:23.334 DEBUG (5284) #] Moving /data/user/mail/reply/new/1414630039.Vfc00I12000eM445784.ghe-tjl2-co-ie => /data/user/incoming-mail/success ``` -You'll notice that `metroplex` catches the inbound message, processes it, then moves the file over to `/data/user/incoming-mail/success`. +You'll notice that `metroplex` catches the inbound message, processes it, then moves the file over to `/data/user/incoming-mail/success`.{% endif %} #### Verify your DNS settings @@ -166,6 +175,8 @@ In order to properly process inbound emails, you must configure a valid A Record If {% data variables.product.product_location %} is behind a firewall or is being served through an AWS Security Group, make sure port 25 is open to all mail servers that send emails to `reply@reply.[hostname]`. #### Contact support - +{% if enterpriseServerVersions contains currentVersion %} If you're still unable to resolve the problem, contact {% data variables.contact.contact_ent_support %}. Please attach the output file from `http(s)://[hostname]/setup/diagnostics` to your email to help us troubleshoot your problem. +{% elsif currentVersion == "github-ae@latest" %} +You can contact {% data variables.contact.github_support %} for help configuring email for notifications to be sent through your SMTP server. For more information, see "[Receiving help from {% data variables.contact.github_support %}](/admin/enterprise-support/receiving-help-from-github-support)." {% endif %} diff --git a/content/admin/configuration/initializing-github-ae.md b/content/admin/configuration/initializing-github-ae.md index 773dd7d1b592..8be6d29791d6 100644 --- a/content/admin/configuration/initializing-github-ae.md +++ b/content/admin/configuration/initializing-github-ae.md @@ -22,9 +22,9 @@ During initialization, the enterprise owner will name your enterprise, configure {% endnote %} 1. To initialize {% data variables.product.product_location %}, you must have a SAML identity provider (IdP). {% data reusables.saml.ae-uses-saml-sso %} To connect your IdP to your enterprise during initialization, you should have your IdP's Entity ID (SSO) URL, Issuer ID URL, and public signing certificate (Base64-encoded). For more information, see "[About identity and access management for your enterprise](/admin/authentication/about-identity-and-access-management-for-your-enterprise)." - + {% note %} - + **Note**: {% data reusables.saml.create-a-machine-user %} {% endnote %} @@ -92,3 +92,28 @@ You can configure the method your users will use to contact your internal suppor ![Text field for internal support contact URL](/assets/images/enterprise/configuration/ae-support-link-url.png) 3. Click **Save**. !["Save" button for enterprise support contact configuration](/assets/images/enterprise/configuration/ae-save.png) + +### Setting your email settings + +Once this is initialized, you can reconfigure any settings after the initialization process. For more information, see "[Configuring email for notifications](/admin/configuration/configuring-email-for-notifications)." + +1. To the right of "Configure email settings", click **Configure**. + !["Configure" button for email settings configuration](/assets/images/enterprise/configuration/ae-email-configure.png) +2. Select **Enable email**. This will enable both outbound and inbound email, however, for inbound email to work you will also need to configure your DNS settings. For more information, see "[Configuring DNS and firewall + settings to allow incoming emails](/admin/configuration/configuring-email-for-notifications#configuring-dns-and-firewall-settings-to-allow-incoming-emails)." + !["Enable" checkbox for email settings configuration](/assets/images/enterprise/configuration/ae-enable-email-configure.png) +3. Complete your email server settings: + - In the **Server address** field, type the address of your SMTP server. + - In the **Port** field, type the port that your SMTP server uses to send email. + - In the **Domain** field, type the domain name that your SMTP server will send with a HELO response, if any. + - In the **Authentication** dropdown, choose the type of encryption used by your SMTP server. + - In the **No-reply email address** field, type the email address to use in the From and To fields for all notification emails. + +4. If you want to discard all incoming emails that are addressed to the no-reply email address, select **Discard email addressed to the no-reply email address**. + !["Discard" checkbox for email settings configuration](/assets/images/enterprise/configuration/ae-discard-email.png) +5. Click **Test email settings**. + !["Test email settings" button for email settings configuration](/assets/images/enterprise/configuration/ae-test-email.png) +6. Under "Send test email to," type the email address where you want to send a test email, then click **Send test email**. + !["Send test email" button for email settings configuration](/assets/images/enterprise/configuration/ae-send-test-email.png) +7. Click **Save**. + !["Save" button for enterprise support contact configuration](/assets/images/enterprise/configuration/ae-save.png) diff --git a/content/admin/configuration/restricting-network-traffic-to-your-enterprise.md b/content/admin/configuration/restricting-network-traffic-to-your-enterprise.md index d20a711bd06d..7edc128771f5 100644 --- a/content/admin/configuration/restricting-network-traffic-to-your-enterprise.md +++ b/content/admin/configuration/restricting-network-traffic-to-your-enterprise.md @@ -1,11 +1,60 @@ --- title: Restricting network traffic to your enterprise shortTitle: Restricting network traffic -intro: 'You can restrict access to your enterprise to connections from specified IP addresses.' +intro: 'You can use an IP allow list to restrict access to your enterprise to connections from specified IP addresses.' versions: github-ae: '*' --- -By default, authorized users can access your enterprise from any IP address. You can restrict access to specific IP addresses such as your physical office locations by contacting support. +### About IP allow lists +By default, authorized users can access your enterprise from any IP address. Enterprise owners can restrict access to assets owned by organizations in an enterprise account by configuring an allow list for specific IP addresses. {% data reusables.identity-and-permissions.ip-allow-lists-example-and-restrictions %} -Contact {% data variables.contact.github_support %} with the IP addresses that should be allowed to access your enterprise. Specify address ranges using the standard CIDR (Classless Inter-Domain Routing) format. {% data variables.contact.github_support %} will configure the appropriate firewall rules for your enterprise to restrict network access over HTTP, SSH, HTTPS, and SMTP. For more information, see "[Receiving help from {% data variables.contact.github_support %}](/enterprise/admin/guides/enterprise-support/receiving-help-from-github-support)." +{% data reusables.identity-and-permissions.ip-allow-lists-cidr-notation %} + +{% data reusables.identity-and-permissions.ip-allow-lists-enable %} + +You can also configure allowed IP addresses for an individual organization. For more information, see "[Managing allowed IP addresses for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization)." + +By default, Azure network security group (NSG) rules leave all inbound traffic open on ports 22, 80, 443, and 25. Enterprise owners can contact {% data variables.contact.github_support %} to configure access restrictions for your instance. + +For instance-level restrictions using Azure NSGs, contact {% data variables.contact.github_support %} with the IP addresses that should be allowed to access your enterprise instance. Specify address ranges using the standard CIDR (Classless Inter-Domain Routing) format. {% data variables.contact.github_support %} will configure the appropriate firewall rules for your enterprise to restrict network access over HTTP, SSH, HTTPS, and SMTP. For more information, see "[Receiving help from {% data variables.contact.github_support %}](/admin/enterprise-support/receiving-help-from-github-support)." + +### Adding an allowed IP address + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.security-tab %} +{% data reusables.identity-and-permissions.ip-allow-lists-add-ip %} +{% data reusables.identity-and-permissions.ip-allow-lists-add-description %} +{% data reusables.identity-and-permissions.ip-allow-lists-add-entry %} + +### Enabling allowed IP addresses + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.security-tab %} +1. Under "IP allow list", select **Enable IP allow list**. + ![Checkbox to allow IP addresses](/assets/images/help/security/enable-ip-allowlist-enterprise-checkbox.png) +4. Click **Save**. + +### Editing an allowed IP address + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.security-tab %} +{% data reusables.identity-and-permissions.ip-allow-lists-edit-entry %} +{% data reusables.identity-and-permissions.ip-allow-lists-edit-ip %} +{% data reusables.identity-and-permissions.ip-allow-lists-edit-description %} +8. Click **Update**. + +### Deleting an allowed IP address + +{% data reusables.enterprise-accounts.access-enterprise %} +{% data reusables.enterprise-accounts.settings-tab %} +{% data reusables.enterprise-accounts.security-tab %} +{% data reusables.identity-and-permissions.ip-allow-lists-delete-entry %} +{% data reusables.identity-and-permissions.ip-allow-lists-confirm-deletion %} + +### Using {% data variables.product.prodname_actions %} with an IP allow list + +{% data reusables.github-actions.ip-allow-list-hosted-runners %} diff --git a/content/admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123.md b/content/admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123.md index 00638ec3d993..536933512434 100644 --- a/content/admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123.md +++ b/content/admin/enterprise-management/migrating-from-github-enterprise-1110x-to-2123.md @@ -81,7 +81,7 @@ To upgrade to the latest version of {% data variables.product.prodname_enterpris ``` 12. Return to the new instance's restore status screen to see that the restore completed. -![Restore complete screen](/assets/images/enterprise/migration/restore-complete-screen.png) +![Restore complete screen](/assets/images/enterprise/migration/migration-status-complete.png) 13. Click **Continue to settings** to review and adjust the configuration information and settings that were imported from the previous instance. ![Review imported settings](/assets/images/enterprise/migration/migration-status-complete.png) 14. Click **Save settings**. diff --git a/content/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise.md b/content/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise.md index d47cc8b225a0..82df246b4335 100644 --- a/content/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise.md +++ b/content/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise.md @@ -5,13 +5,15 @@ redirect_from: - /enterprise/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise versions: enterprise-server: '>=2.22' + github-ae: '*' --- +{% data reusables.actions.ae-beta %} {% data reusables.actions.enterprise-beta %} ### About {% data variables.product.prodname_actions %} permissions for your enterprise -When you enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, it is enabled for all organizations in your enterprise. You can choose to disable {% data variables.product.prodname_actions %} for all organizations in your enterprise, or only allow specific organizations. You can also limit the use of public actions, so that people can only use local actions that exist in your enterprise. +{% if currentVersion == "github-ae@latest" %}{% else %}When you enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, it is enabled for all organizations in your enterprise. {% endif %}You can choose to disable {% data variables.product.prodname_actions %} for all organizations in your enterprise, or only allow specific organizations. You can also limit the use of public actions, so that people can only use local actions that exist in your enterprise. ### Managing {% data variables.product.prodname_actions %} permissions for your enterprise @@ -20,7 +22,7 @@ When you enable {% data variables.product.prodname_actions %} on {% data variabl {% data reusables.enterprise-accounts.actions-tab %} {% data reusables.actions.enterprise-actions-permissions %} -{% if currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest"%} ### Enabling workflows for private repository forks {% data reusables.github-actions.private-repository-forks-overview %} diff --git a/content/admin/github-actions/getting-started-with-github-actions-for-github-ae.md b/content/admin/github-actions/getting-started-with-github-actions-for-github-ae.md new file mode 100644 index 000000000000..4ce90c5b50bd --- /dev/null +++ b/content/admin/github-actions/getting-started-with-github-actions-for-github-ae.md @@ -0,0 +1,30 @@ +--- +title: Getting started with GitHub Actions for GitHub AE +intro: 'Learn configuring {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_managed %}.' +permissions: 'Site administrators can enable {% data variables.product.prodname_actions %} and configure enterprise settings.' +versions: + github-ae: '*' +--- + +{% data reusables.actions.ae-beta %} + +This article explains how site administrators can configure {% data variables.product.prodname_ghe_managed %} to use {% data variables.product.prodname_actions %}. + +### Managing access permissions for {% data variables.product.prodname_actions %} in your enterprise + +You can use policies to manage access to {% data variables.product.prodname_actions %}. For more information, see "[Enforcing GitHub Actions policies for your enterprise](/admin/github-actions/enforcing-github-actions-policies-for-your-enterprise)." + +### Adding runners + +{% note %} + +**Note:** To add {% data variables.actions.hosted_runner %}s to {% data variables.product.prodname_ghe_managed %}, you will need to contact {% data variables.product.prodname_dotcom %} support. + +{% endnote %} + +To run {% data variables.product.prodname_actions %} workflows, you need to add runners. You can add runners at the enterprise, organization, or repository levels. For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)." + + +### General security hardening for {% data variables.product.prodname_actions %} + +If you want to learn more about security practices for {% data variables.product.prodname_actions %}, see "[Security hardening for {% data variables.product.prodname_actions %}](/actions/learn-github-actions/security-hardening-for-github-actions)." diff --git a/content/admin/github-actions/index.md b/content/admin/github-actions/index.md index 55495f30bc2f..e7917e912a17 100644 --- a/content/admin/github-actions/index.md +++ b/content/admin/github-actions/index.md @@ -1,17 +1,22 @@ --- title: Managing GitHub Actions for your enterprise -intro: 'Enable {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_server %}, and manage {% data variables.product.prodname_actions %} policies and settings.' +intro: 'Enable {% data variables.product.prodname_actions %} on {% if currentVersion == "github-ae@latest" %}{% data variables.product.prodname_ghe_managed %}{% else %}{% data variables.product.prodname_ghe_server %}{% endif %}, and manage {% data variables.product.prodname_actions %} policies and settings.' redirect_from: - /enterprise/admin/github-actions versions: enterprise-server: '>=2.22' + github-ae: '*' --- +{% data reusables.actions.ae-beta %} {% data reusables.actions.enterprise-beta %} {% data reusables.actions.enterprise-github-hosted-runners %} ### Table of Contents +{% topic_link_in_list /using-github-actions-in-github-ae %} + {% link_in_list /getting-started-with-github-actions-for-github-ae %} + {% topic_link_in_list /enabling-github-actions-for-github-enterprise-server %} {% link_in_list /getting-started-with-github-actions-for-github-enterprise-server %} {% link_in_list /enabling-github-actions-with-azure-blob-storage %} diff --git a/content/admin/github-actions/using-github-actions-in-github-ae.md b/content/admin/github-actions/using-github-actions-in-github-ae.md new file mode 100644 index 000000000000..9c05715d1101 --- /dev/null +++ b/content/admin/github-actions/using-github-actions-in-github-ae.md @@ -0,0 +1,7 @@ +--- +title: Using GitHub Actions in GitHub AE +intro: 'Learn how to configure {% data variables.product.prodname_actions %} on {% data variables.product.prodname_ghe_managed %}.' +mapTopic: true +versions: + github-ae: '*' +--- diff --git a/content/admin/overview/about-data-residency.md b/content/admin/overview/about-data-residency.md new file mode 100644 index 000000000000..a83066177e99 --- /dev/null +++ b/content/admin/overview/about-data-residency.md @@ -0,0 +1,12 @@ +--- +title: About data residency +intro: You can choose the geography where {% data variables.product.product_name %} stores all customer data for your enterprise. +versions: + github-ae: '*' +--- + +{% data reusables.github-ae.github-ae-enables-you %} You can choose the geography where you store all the customer data for {% data variables.product.product_location %}, and members of your enterprise can access {% data variables.product.product_name %} from anywhere in the world. + +When creating your enterprise, you can tell {% data variables.contact.contact_enterprise_sales %} where to store your customer data. {% data variables.product.company_short %} will not store or move any of your enterprise's data outside of the geography you choose. + +For more information about the available geographies, contact {% data variables.contact.contact_enterprise_sales %}. diff --git a/content/admin/overview/about-github-ae.md b/content/admin/overview/about-github-ae.md index d143dd1af08f..a864f01f3818 100644 --- a/content/admin/overview/about-github-ae.md +++ b/content/admin/overview/about-github-ae.md @@ -1,17 +1,15 @@ --- title: About GitHub AE -intro: '{% data variables.product.prodname_ghe_managed %} is the most secure and compliant way to use {% data variables.product.prodname_dotcom %}.' +intro: '{% data variables.product.prodname_ghe_managed %} is a security-enhanced and compliant way to use {% data variables.product.prodname_dotcom %} in the cloud.' versions: github-ae: '*' --- ### About {% data variables.product.prodname_ghe_managed %} -{% data reusables.github-ae.github-ae-enables-you %} +{% data reusables.github-ae.github-ae-enables-you %} {% data variables.product.prodname_ghe_managed %} is fully managed, reliable, and scalable, allowing you to accelerate delivery without sacrificing risk management. -{% data variables.product.prodname_ghe_managed %} offers one developer platform from idea to production. You can increase developer velocity, automate entire workflows, secure your code, and collaborate in developers’ favorite tool. - -{% data variables.product.prodname_ghe_managed %} provides your organization with all the power of [{% data variables.product.prodname_enterprise %}](https://github.com/enterprise). With {% data variables.product.prodname_ghe_managed %}, you can also meet security and compliance goals with a suite of features and certifications that put you in control. +{% data variables.product.prodname_ghe_managed %} offers one developer platform from idea to production. You can increase development velocity with the tools that teams know and love, while you maintain industry and regulatory compliance with unique security and access controls, workflow automation, and policy enforcement. ### A highly available and planet-scale cloud @@ -36,11 +34,3 @@ Secure access to your enterprise on {% data variables.product.prodname_ghe_manag ### Commercial and government environments {% data variables.product.prodname_ghe_managed %} is available in the Azure Government cloud, the trusted cloud for US government agencies and their partners. {% data variables.product.prodname_ghe_managed %} is also available in the commercial cloud, so you can choose the hosting environment that is right for your organization. - -### Premium Plus support - -Premium Plus support is available for all {% data variables.product.prodname_ghe_managed %} customers, to ensure you have the fastest and most personal support experience. A dedicated Account Manager will work with you to help you get the most out of {% data variables.product.prodname_dotcom %}. Our support team will resolve issues any time of day, in the shortest possible time. - -### About billing for {% data variables.product.prodname_ghe_managed %} - -{% data reusables.github-ae.about-billing %} For more information, see "[Managing billing for your enterprise](/admin/overview/managing-billing-for-your-enterprise)." \ No newline at end of file diff --git a/content/admin/overview/about-upgrades-to-new-releases.md b/content/admin/overview/about-upgrades-to-new-releases.md index 19b7d28e7fa0..f25eeb31ca24 100644 --- a/content/admin/overview/about-upgrades-to-new-releases.md +++ b/content/admin/overview/about-upgrades-to-new-releases.md @@ -1,14 +1,17 @@ --- title: About upgrades to new releases shortTitle: About upgrades -intro: 'You can benefit from new features and bug fixes for {% data variables.product.product_name %} by upgrading your enterprise to a newly released version.' +intro: '{% if currentVersion == "github-ae@latest" %}Your {% data variables.product.product_name %} enterprise is updated with the latest features and bug fixes on a regular basis by {% data variables.product.company_short %}.{% else %}You can benefit from new features and bug fixes for {% data variables.product.product_name %} by upgrading your enterprise to a newly released version.{% endif %}' versions: enterprise-server: '>=3.0' + github-ae: '*' --- -{% data variables.product.product_name %} is constantly improving, with new functionality and bug fixes introduced through major and minor releases. +{% data variables.product.product_name %} is constantly improving, with new functionality and bug fixes introduced through major and minor releases. {% if currentVersion == "github-ae@latest" %}{% data variables.product.prodname_ghe_managed %} is a fully managed service, so {% data variables.product.company_short %} completes the upgrade process for your enterprise.{% endif %} -Major releases include new functionality and feature upgrades and typically occur quarterly. +Major releases include new functionality and feature upgrades and typically occur {% if currentVersion == "github-ae@latest" %}every few weeks or months{% else %} quarterly{% endif %}. {% if currentVersion == "github-ae@latest" %}{% data variables.product.company_short %} will upgrade your enterprise to the latest major release. You will be given advance notice of any planned downtime for your enterprise.{% endif %} + +{% if enterpriseServerVersions contains currentVersion %} Starting with {% data variables.product.prodname_ghe_server %} 3.0, all major releases begin with at least one release candidate. Release candidates are proposed major releases, with a complete feature set. There may be bugs or issues in a release candidate which can only be found through feedback from customers actually using {% data variables.product.product_name %}. @@ -18,16 +21,25 @@ Release candidates should be deployed on test or staging environments. As you te We'll use your feedback to apply bug fixes and any other necessary changes to create a stable production release. Each new release candidate adds bug fixes for issues found in prior versions. When the release is ready for widespread adoption, {% data variables.product.company_short %} publishes a stable production release. +{% endif %} + {% warning %} **Warning**: The upgrade to a new major release will cause a few hours of downtime, during which none of your users will be able to use the enterprise. You can inform your users about downtime by publishing a global announcement banner, using your enterprise settings or the REST API. For more information, see "[Customizing user messages on your instance](/admin/user-management/customizing-user-messages-on-your-instance#creating-a-global-announcement-banner)" and "[{% data variables.product.prodname_enterprise %} administration](/rest/reference/enterprise-admin#announcements)." {% endwarning %} +{% if enterpriseServerVersions contains currentVersion %} + Minor releases, which consist of hot patches and bug fixes only, happen more frequently. Minor releases are generally available when first released, with no release candidates. Upgrading to a minor release typically requires less than five minutes of downtime. To upgrade your enterprise to a new release, see "[Release notes](/enterprise-server/admin/release-notes)" and "[Upgrading {% data variables.product.prodname_ghe_server %}](/admin/enterprise-management/upgrading-github-enterprise-server)." +{% endif %} + ### Further reading - [ {% data variables.product.prodname_roadmap %} ]( {% data variables.product.prodname_roadmap_link %} ) in the `github/roadmap` repository +{% if currentVersion == "github-ae@latest" %} +- [ {% data variables.product.prodname_ghe_managed %} release notes](/admin/overview/github-ae-release-notes) +{% endif %} diff --git a/content/admin/overview/github-ae-release-notes.md b/content/admin/overview/github-ae-release-notes.md new file mode 100644 index 000000000000..2033e9639900 --- /dev/null +++ b/content/admin/overview/github-ae-release-notes.md @@ -0,0 +1,81 @@ +--- +title: GitHub AE release notes +intro: March 1, 2021 +versions: + github-ae: '*' +--- + +### Features + +#### {% data variables.product.prodname_actions %} beta + +[{% data variables.product.prodname_actions %}](https://github.com/features/actions) is a powerful, flexible solution for CI/CD and workflow automation. For more information, see "[Introduction to {% data variables.product.prodname_actions %}](/actions/learn-github-actions/introduction-to-github-actions)." + +{% data variables.product.prodname_actions %} on {% data variables.product.product_name %} uses a new [{% data variables.actions.hosted_runner %}](/actions/using-github-hosted-runners/about-ae-hosted-runners), only available for {% data variables.product.product_name %}, that enables you to customize the size, image, and networking configuration of the runners. These runners are a finished-service CI compute environment with auto-scaling and management, fully managed by {% data variables.product.company_short %}. During the beta, the use {% data variables.actions.hosted_runner %}s is free of charge. For more information, see "[Adding {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/adding-ae-hosted-runners)." + +Please note that when {% data variables.product.prodname_actions %} is enabled during this upgrade, two organizations named "GitHub Actions" (@**actions** and @**github**) will appear in {% data variables.product.product_location %}. These organizations are required by {% data variables.product.prodname_actions %}. Users named @**ghost** and @**actions** appear as the actors for creation of these organizations in the audit log. + + +#### {% data variables.product.prodname_registry %} beta + +[{% data variables.product.prodname_registry %}](https://github.com/features/packages) is a package hosting service, natively integrated with {% data variables.product.prodname_actions %}, APIs, and webhooks. Create an [end-to-end DevOps workflow](/github-ae@latest/packages/quickstart) that includes your code, continuous integration, and deployment solutions. During this beta, {% data variables.product.prodname_registry %} is offered free of charge to {% data variables.product.product_name %} customers. + +#### {% data variables.product.prodname_GH_advanced_security %} beta + +{% data variables.product.prodname_GH_advanced_security %} is available in beta and includes both code scanning and secret scanning. During this beta, {% data variables.product.prodname_GH_advanced_security %} features are being offered free of charge to {% data variables.product.product_name %} customers. Repository and organization administrators can opt-in to use {% data variables.product.prodname_GH_advanced_security %} in the Security and Analysis tab under settings. + +Learn more about {% data variables.product.prodname_GH_advanced_security %} [code scanning](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning) and [secret scanning](/github/administering-a-repository/about-secret-scanning) on {% data variables.product.prodname_ghe_managed %}. + +#### Manage teams from your identity provider (IdP) + +Customers using SCIM (System for Cross-domain Identity Management) can now sync security groups in Azure Active Directory with {% data variables.product.company_short %} teams. Once a team has been linked to a security group, membership will be automatically updated in {% data variables.product.product_name %} when a user is added or removed from their assigned security group. + +#### IP allow lists beta + +[{% data variables.product.company_short %} IP allow lists](/admin/configuration/restricting-network-traffic-to-your-enterprise) provide the ability to filter traffic from administrator-specified IP ranges, defined by CIDR notation. The allow list is defined at the enterprise or organization account level in Security > Settings. All traffic that attempts to reach resources within the enterprise account and organizations are filtered by the IP allow lists. This functionality is provided in addition to the ability to request network security group changes that filter traffic to the entirety of the GHAE tenant. + + +### Changes + +#### Developer changes + +- [Organization owners can now disable publication](/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization) of {% data variables.product.prodname_pages %} sites from repositories in the organization. This will not unpublish existing sites. +- Repositories that use {% data variables.product.prodname_pages %} can now [build and deploy from any branch](/github/working-with-github-pages/about-github-pages#publishing-sources-for-github-pages-sites). +- When writing an issue or pull request, the list syntax for bullets, numbers, and tasks will now be autocompleted after you press `return` or `enter`. +- You can now delete a directory in a repository from the repository page. When navigating to a directory, a new kebab button next to the "Add file" button gives the option to delete the directory. +- It’s now easier and faster to [reference issues or pull requests](/github/writing-on-github/basic-writing-and-formatting-syntax#referencing-issues-and-pull-requests), with search across multiple words after the "#". + +##### Administration changes + +- Enterprise owners can now publish a mandatory message. The message is shown to all users and they must acknowledge it. This can be used to display important information, terms of service or policies. +- The {% data variables.product.prodname_github_app%} single file path permission can now [support up to ten files](/developers/apps/creating-a-github-app-using-url-parameters). +- When configuring a {% data variables.product.prodname_github_app%}, the authorization callback URL is a required field. Now we will permit the integrator to specify multiple callback URLs. {% data variables.product.product_name %} denies authorization if the callback URL from the request is not listed. +- A [new API endpoint](/rest/reference/apps#create-a-scoped-access-token) enables the exchange of a user to server token for a user to server token scoped to specific repositories. +- Events are now logged in the audit log on [promoting a team member to be a team maintainer and on demoting a team maintainer to be a team member](/admin/user-management/audited-actions#teams). +- The [OAuth device authorization flow](/developers/apps/authorizing-oauth-apps#device-flow) is now supported. This allows any CLI client or developer tool to authenticate using a secondary system. +- A user can no longer delete their account if SCIM provisioning is enabled. + +##### Default branch renaming + +Enterprise and organization owners can now set the default branch name for new repositories. Enterprise owners can also enforce their choice of default branch name across all organizations or allow individual organizations to choose their own. + +Existing repositories are unaffected by these settings, and their default branch name will not be changed. + +This change is one of many changes {% data variables.product.company_short %} is making to support projects and maintainers that want to rename their default branch. To learn more, see [github/renaming](https://github.com/github/renaming). + + +### Bug fixes +- Users can no longer set a backup email address on their profile. Their email address is set through the IdP only. +- You can no longer enable two-factor authentication after configuring authentication through your IdP. +- {% data variables.product.product_name %} can now connect to Azure Boards. +- Version headers were missing from the APIs, and have now been set to "GitHub AE." +- Links to documentation have been fixed. +- Configuration of audit log forwarding within the enterprise's settings was failing. +- Navigating to gists could result in a 500 error. +- The Support email or URL was failing to save. It now saves after a period of a few minutes. +- Organization level pull request templates were not being applied to all pull requests in the organization. + +### Known issues + +- Geographic location data is not shown in the audit log. Location information can otherwise be discerned from the IP address associated with each event. +- The link to {% data variables.product.prodname_registry %} from a repository page shows an incorrect search page when that repository does not have any packages. diff --git a/content/admin/overview/index.md b/content/admin/overview/index.md index 099c1c1d54d3..607f86a51df2 100644 --- a/content/admin/overview/index.md +++ b/content/admin/overview/index.md @@ -13,9 +13,12 @@ For more information, or to purchase {% data variables.product.prodname_enterpri ### Table of Contents {% link_in_list /about-github-ae %} +{% link_in_list /about-upgrades-to-new-releases %} +{% link_in_list /about-data-residency %} {% link_in_list /about-enterprise-accounts %} {% link_in_list /managing-your-github-enterprise-license %} {% link_in_list /managing-billing-for-your-enterprise %} {% link_in_list /about-upgrades-to-new-releases %} {% link_in_list /system-overview %} {% link_in_list /about-the-github-enterprise-api %} +{% link_in_list /github-ae-release-notes %} diff --git a/content/admin/overview/managing-your-github-enterprise-license.md b/content/admin/overview/managing-your-github-enterprise-license.md index 3b1f4646ee01..b5c69a8999af 100644 --- a/content/admin/overview/managing-your-github-enterprise-license.md +++ b/content/admin/overview/managing-your-github-enterprise-license.md @@ -18,13 +18,17 @@ versions: ### About {% data variables.product.prodname_enterprise %} licenses -When you purchase or renew {% data variables.product.prodname_enterprise %}, you receive a license file to validate your application. A license file has an expiration date and controls the number of user licenses you can add to {% data variables.product.prodname_enterprise %}. After you download and install {% data variables.product.prodname_enterprise %}, uploading the license file unlocks the application for you to use. +When you purchase or renew {% data variables.product.prodname_enterprise %}, you receive a license file to validate your application. A license file has an expiration date and controls the number of user licenses you can add to {% data variables.product.prodname_enterprise %}. After you download and install {% data variables.product.prodname_enterprise %}, uploading the license file unlocks the application for you to use. For more information about downloading {% data variables.product.prodname_enterprise %}, see the [{% data variables.product.prodname_enterprise %} Releases](https://enterprise.github.com/releases/) website. For information about setting up {% data variables.product.product_location %}, see "[Setting up a {% data variables.product.prodname_enterprise %} instance](/admin/installation/setting-up-a-github-enterprise-server-instance)." + You can allocate the user licenses included in your {% data variables.product.prodname_enterprise %} license to users in {% data variables.product.product_location_enterprise %} and a {% data variables.product.prodname_ghe_cloud %} enterprise account. When you add a user to either environment, they will consume a license. If a user has accounts in both environments, to consume only one license, their primary {% data variables.product.prodname_enterprise %} email address must be the same as their verified {% data variables.product.prodname_ghe_cloud %} email address. You can sync license count and usage between the environments. If your {% data variables.product.prodname_ghe_server %} license expires, you won't be able to access {% data variables.product.product_location_enterprise %} via a web browser or Git. If needed, you will be able to use command-line utilities to back up all your data. For more information, see "[Configuring backups on your appliance](/enterprise/admin/guides/installation/configuring-backups-on-your-appliance)." If you have any questions about renewing your license, contact {% data variables.contact.contact_enterprise_sales %}. -### Uploading a new license to {% data variables.product.prodname_ghe_server %} +You can download your {% data variables.product.prodname_ghe_server %} license from your [enterprise account](https://enterprise.github.com/download). For more information, see "[Managing your {% data variables.product.prodname_enterprise %} license](/admin/overview/managing-your-github-enterprise-license#uploading-a-new-license-to-github-enterprise-server)." + +### Uploading a new license to {% data variables.product.prodname_ghe_server %} + After you purchase a new license or upgrade an existing license from {% data variables.contact.contact_enterprise_sales %}, you must download your new license file, then upload the file to {% data variables.product.prodname_ghe_server %} to unlock your new user licenses. diff --git a/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md b/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md index 46a402df723f..9f92df1f8777 100644 --- a/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md +++ b/content/admin/packages/getting-started-with-github-packages-for-your-enterprise.md @@ -40,7 +40,7 @@ To enable {% data variables.product.prodname_registry %} and configure third-par ### Step 2: Specify the package ecosystems to support on your instance -Choose which package ecosystems you'd like to enable, disable, or set to read-only on your {% data variables.product.product_location %}. Available options are Docker, RubyGems, npm, Apache Maven, Gradle, or NuGet. For more information, see "[Configuring package ecosystem support for your enterprise](/enterprise/admin/packages/configuring-package-ecosystem-support-for-your-enterprise)." +Choose which package ecosystems you'd like to enable, disable, or set to read-only on {% data variables.product.product_location %}. Available options are Docker, RubyGems, npm, Apache Maven, Gradle, or NuGet. For more information, see "[Configuring package ecosystem support for your enterprise](/enterprise/admin/packages/configuring-package-ecosystem-support-for-your-enterprise)." ### Step 3: Ensure you have a TLS certificate for your package host URL, if needed diff --git a/content/admin/user-management/audited-actions.md b/content/admin/user-management/audited-actions.md index 299314ab07b4..57ed82a23046 100644 --- a/content/admin/user-management/audited-actions.md +++ b/content/admin/user-management/audited-actions.md @@ -1,6 +1,7 @@ --- title: Audited actions intro: You can search the audit log for a wide variety of actions. +miniTocMaxHeadingLevel: 4 redirect_from: - /enterprise/admin/articles/audited-actions/ - /enterprise/admin/installation/audited-actions @@ -56,6 +57,22 @@ Action | Description `enterprise.config.lock_anonymous_git_access` | A site admin locks anonymous Git read access to prevent repository admins from changing existing anonymous Git read access settings for repositories in the enterprise. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)." `enterprise.config.unlock_anonymous_git_access` | A site admin unlocks anonymous Git read access to allow repository admins to change existing anonymous Git read access settings for repositories in the enterprise. For more information, see "[Enforcing repository management policies in your enterprise](/admin/policies/enforcing-repository-management-policies-in-your-enterprise#configuring-anonymous-git-read-access)."{% endif %} +{% if currentVersion == "github-ae@latest" %} + +#### IP allow lists + +Name | Description +------------------------------------:| ----------------------------------------------------------- +`ip_allow_list_entry.create` | An IP address was added to an IP allow list. +`ip_allow_list_entry.update` | An IP address or its description was changed. +`ip_allow_list_entry.destroy` | An IP address was deleted from an IP allow list. +`ip_allow_list.enable` | An IP allow list was enabled. +`ip_allow_list.enable_for_installed_apps` | An IP allow list was enabled for installed {% data variables.product.prodname_github_apps %}. +`ip_allow_list.disable` | An IP allow list was disabled. +`ip_allow_list.disable_for_installed_apps` | An IP allow list was disabled for installed {% data variables.product.prodname_github_apps %}. + +{% endif %} + #### Issues and pull requests Action | Description diff --git a/content/admin/user-management/migrating-data-to-your-enterprise.md b/content/admin/user-management/migrating-data-to-your-enterprise.md index 0cfce09e13a1..e1a120ba63e2 100644 --- a/content/admin/user-management/migrating-data-to-your-enterprise.md +++ b/content/admin/user-management/migrating-data-to-your-enterprise.md @@ -17,10 +17,12 @@ versions: ### Applying the imported data on {% data variables.product.prodname_ghe_server %} +Once you have [prepared your migration](/admin/user-management/preparing-to-migrate-data-to-your-enterprise) you can use the following steps to complete the migration. + {% data reusables.enterprise_installation.ssh-into-target-instance %} 2. Using the `ghe-migrator import` command, start the import process. You'll need: - * Your Migration GUID. + * Your Migration GUID. For more information, see "[Preparing to migrate data to your enterprise](/admin/user-management/preparing-to-migrate-data-to-your-enterprise)." * Your personal access token for authentication. The personal access token that you use is only for authentication as a site administrator, and does not require any specific scope. For more information, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." ```shell diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/index.md b/content/desktop/contributing-and-collaborating-using-github-desktop/index.md index 3b94ba23119e..2e0f6b62fd21 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/index.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/index.md @@ -19,6 +19,7 @@ versions: {% topic_link_in_list /making-changes-in-a-branch %} {% link_in_list /managing-branches %} {% link_in_list /committing-and-reviewing-changes-to-your-project %} + {% link_in_list /stashing-changes %} {% link_in_list /pushing-changes-to-github %} {% link_in_list /reverting-a-commit %} {% link_in_list /managing-tags %} diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/managing-branches.md b/content/desktop/contributing-and-collaborating-using-github-desktop/managing-branches.md index 879ecd209788..e836389a0bb0 100644 --- a/content/desktop/contributing-and-collaborating-using-github-desktop/managing-branches.md +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/managing-branches.md @@ -30,7 +30,7 @@ You can always create a branch in {% data variables.product.prodname_desktop %} {% mac %} {% data reusables.desktop.click-base-branch-in-drop-down %} - ![Drop-down menu to switch your current branch](/assets/images/help/desktop/click-branch-in-drop-down-mac.png) + ![Drop-down menu to switch your current branch](/assets/images/help/desktop/select-branch-to-delete.png) {% data reusables.desktop.create-new-branch %} ![New Branch option in the Branch menu](/assets/images/help/desktop/new-branch-button-mac.png) {% data reusables.desktop.name-branch %} @@ -62,13 +62,12 @@ You can always create a branch in {% data variables.product.prodname_desktop %} If you create a branch on {% data variables.product.product_name %}, you'll need to publish the branch to make it available for collaboration on {% data variables.product.prodname_dotcom %}. 1. At the top of the app, click {% octicon "git-branch" aria-label="The branch icon" %} **Current Branch**, then click the branch that you want to publish. - ![Drop-down menu to select which branch to publish](/assets/images/help/desktop/click-branch-in-drop-down-mac.png) + ![Drop-down menu to select which branch to publish](/assets/images/help/desktop/select-branch-to-delete.png) 2. Click **Publish branch**. ![The Publish branch button](/assets/images/help/desktop/publish-branch-button.png) ### Switching between branches -You can view and make commits to any of your repository's branches. If you have uncommitted, saved changes, you'll need to decide what to do with your changes before you can switch branches. You can commit your changes on the current branch, stash your changes on the current branch, or bring the changes to your new branch. If you want to commit your changes on the current branch, follow the steps in "[Committing and reviewing changes to your project](/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project)" before switching branches. - +You can view and make commits to any of your repository's branches. If you have uncommitted, saved changes, you'll need to decide what to do with your changes before you can switch branches. You can commit your changes on the current branch, stash your changes to temporarily save them on the current branch, or bring the changes to your new branch. If you want to commit your changes before switching branches, see "[Committing and reviewing changes to your project](/desktop/contributing-to-projects/committing-and-reviewing-changes-to-your-project)." {% tip %} **Tip**: You can set a default behavior for switching branches in the **Advanced** settings. For more information, see "[Configuring basic settings](/desktop/getting-started-with-github-desktop/configuring-basic-settings)." @@ -77,21 +76,10 @@ You can view and make commits to any of your repository's branches. If you have {% data reusables.desktop.current-branch-menu %} {% data reusables.desktop.switching-between-branches %} - ![List of branches in the repository](/assets/images/help/desktop/click-branch-in-drop-down-mac.png) + ![List of branches in the repository](/assets/images/help/desktop/select-branch-to-delete.png) 3. If you have saved, uncommitted changes, choose **Leave my changes** or **Bring my changes**, then click **Switch Branch**. ![Switch branch with changes options](/assets/images/help/desktop/stash-changes-options.png) -### Retrieving stashed changes -To access changes you've stashed in another branch, switch back to the branch you stashed the changes in. - -{% data reusables.desktop.current-branch-menu %} -{% data reusables.desktop.switching-between-branches %} - ![List of branches in the repository](/assets/images/help/desktop/click-branch-in-drop-down-mac.png) -3. In the left sidebar, click **Stashed Changes**. -![Stashed changes option](/assets/images/help/desktop/stashed-changes.png) -4. To delete your stashed changes, click **Discard**, or to use your stashed changes, click **Restore**. -![Discard or Restore stashed changes](/assets/images/help/desktop/discard-restore-stash-buttons.png) - ### Deleting a branch You can't delete a branch if it's currently associated with an open pull request. You cannot undo deleting a branch. @@ -120,3 +108,4 @@ You can't delete a branch if it's currently associated with an open pull request - "[Branch](/articles/github-glossary/#branch)" in the {% data variables.product.prodname_dotcom %} glossary - "[About branches](/articles/about-branches)" - "[Branches in a Nutshell](https://git-scm.com/book/en/v2/Git-Branching-Branches-in-a-Nutshell)" in the Git documentation +- "[Stashing changes](/desktop/contributing-and-collaborating-using-github-desktop/stashing-changes)" diff --git a/content/desktop/contributing-and-collaborating-using-github-desktop/stashing-changes.md b/content/desktop/contributing-and-collaborating-using-github-desktop/stashing-changes.md new file mode 100644 index 000000000000..54122ffc3917 --- /dev/null +++ b/content/desktop/contributing-and-collaborating-using-github-desktop/stashing-changes.md @@ -0,0 +1,29 @@ +--- +title: Stashing changes +intro: You can temporarily save your changes without committing them to a branch by stashing the changes. +versions: + free-pro-team: '*' +--- + +### About stashed changes + +To apply your changes to your repository, you must save the files and then commit the changes to a branch. If you have saved changes that you are not ready to commit yet, you can stash the changes for later. When you stash changes, the changes are temporarily removed from the files and you can choose to restore or discard the changes later. You can only stash one set of changes at a time with {% data variables.product.prodname_desktop %}. If you use {% data variables.product.prodname_desktop %} to stash changes, all unsaved changes will be stashed. After you stash changes on a branch, you can safely change branches or make other changes to your current branch. + +If you use {% data variables.product.prodname_desktop %} to switch branches while you have saved, but not committed, changes, {% data variables.product.prodname_desktop %} will prompt you to stash the changes or bring them to the other branch. For more information, see "[Managing branches](/desktop/contributing-to-projects/managing-branches#switching-between-branches)." + +### Stashing changes + +{% data reusables.desktop.click-changed-files-header %} +{% data reusables.desktop.click-stash-all-changes %} + +### Restoring stashed changes + +{% data reusables.desktop.navigate-to-stashed-changes %} +{% data reusables.desktop.click-stashed-changes %} +{% data reusables.desktop.click-restore %} + +### Discarding stashed changes + +{% data reusables.desktop.navigate-to-stashed-changes %} +{% data reusables.desktop.click-stashed-changes %} +{% data reusables.desktop.click-discard %} diff --git a/content/desktop/installing-and-configuring-github-desktop/authenticating-to-github.md b/content/desktop/installing-and-configuring-github-desktop/authenticating-to-github.md index 8bb5f14c5a33..dda5c4f09277 100644 --- a/content/desktop/installing-and-configuring-github-desktop/authenticating-to-github.md +++ b/content/desktop/installing-and-configuring-github-desktop/authenticating-to-github.md @@ -24,7 +24,7 @@ Before you authenticate, {% data reusables.desktop.get-an-account %} 3. To the right of "{% data variables.product.prodname_dotcom_the_website %}," click **Sign In**. ![The Sign In button for GitHub](/assets/images/help/desktop/mac-sign-in-github.png) 4. In the "Sign in" pane, click **Sign in using your browser**. {% data variables.product.prodname_desktop %} will open your default browser. - ![The Sign in using your browser link](/assets/images/help/desktop/mac-sign-in-browser.png) + ![The Sign in using your browser link](/assets/images/help/desktop/sign-in-browser.png) {% data reusables.user_settings.password-authentication-deprecation-desktop %} @@ -54,7 +54,7 @@ Before you authenticate, {% data reusables.desktop.get-an-account %} 3. To the right of "GitHub.com," click **Sign in**. ![The Sign In button for GitHub](/assets/images/help/desktop/windows-sign-in-github.png) 4. In the Sign in pane, click **Sign in using your browser**. - ![The Sign in using your browser link](/assets/images/help/desktop/windows-sign-in-browser.png) + ![The Sign in using your browser link](/assets/images/help/desktop/sign-in-browser.png) {% data reusables.user_settings.password-authentication-deprecation-desktop %} diff --git a/content/developers/apps/building-github-apps.md b/content/developers/apps/building-github-apps.md index 0012cdf9cef2..91bb4479af95 100644 --- a/content/developers/apps/building-github-apps.md +++ b/content/developers/apps/building-github-apps.md @@ -1,6 +1,6 @@ --- title: Building GitHub Apps -intro: You can build GitHub Apps for personal or public use. Learn how to register and set up permissions and authentication options for GitHub Apps. +intro: You can build GitHub Apps for yourself or others to use. Learn how to register and set up permissions and authentication options for GitHub Apps. mapTopic: true redirect_from: - /apps/building-integrations/setting-up-and-registering-github-apps/ diff --git a/content/developers/apps/building-oauth-apps.md b/content/developers/apps/building-oauth-apps.md index 92ea416d43fb..ccedbd626704 100644 --- a/content/developers/apps/building-oauth-apps.md +++ b/content/developers/apps/building-oauth-apps.md @@ -1,6 +1,6 @@ --- title: Building OAuth Apps -intro: You can build OAuth Apps for personal or public use. Learn how to register and set up permissions and authorization options for OAuth Apps. +intro: You can build OAuth Apps for yourself or others to use. Learn how to register and set up permissions and authorization options for OAuth Apps. mapTopic: true redirect_from: - /apps/building-integrations/setting-up-and-registering-oauth-apps/ diff --git a/content/developers/apps/creating-a-github-app.md b/content/developers/apps/creating-a-github-app.md index 054cc4493af9..cae49a410a84 100644 --- a/content/developers/apps/creating-a-github-app.md +++ b/content/developers/apps/creating-a-github-app.md @@ -75,7 +75,7 @@ versions: 13. In "Permissions", choose the permissions your app will request. For each type of permission, use the drop-down menu and click **Read-only**, **Read & write**, or **No access**. ![Various permissions for your GitHub App](/assets/images/github-apps/github_apps_new_permissions_post2dot13.png) -14. In "Subscribe to events", choose whether to subscribe your app to **Label**, **Public**, **Repository**, or **Watch** events. ![Subscribe to events options for your GitHub App](/assets/images/github-apps/github_apps_subscribe_to_events.png) +14. In "Subscribe to events", choose the events you want your app to receive. 15. To choose where the app can be installed, select either **Only on this account** or **Any account**. For more information on installation options, see "[Making a GitHub App public or private](/apps/managing-github-apps/making-a-github-app-public-or-private/)." ![Installation options for your GitHub App](/assets/images/github-apps/github_apps_installation_options.png) 16. Click **Create GitHub App**. diff --git a/content/developers/apps/installing-github-apps.md b/content/developers/apps/installing-github-apps.md index 3e54b9d62226..c997ded78ac8 100644 --- a/content/developers/apps/installing-github-apps.md +++ b/content/developers/apps/installing-github-apps.md @@ -1,6 +1,6 @@ --- title: Installing GitHub Apps -intro: 'When your app is public, anyone can install your app on their repository through {% if currentVersion == "free-pro-team@latest" %} the {% data variables.product.prodname_marketplace %} or {% endif %}an installation URL. When your app is private, you can only install the app on repositories that you own.' +intro: 'When your app is public, anyone can use {% if currentVersion == "free-pro-team@latest" %} the {% data variables.product.prodname_marketplace %} or {% endif %}an installation URL to install the app on their repository. When your app is private, only you can install the app on repositories that you own.' redirect_from: - /apps/installing-github-apps versions: diff --git a/content/developers/apps/making-a-github-app-public-or-private.md b/content/developers/apps/making-a-github-app-public-or-private.md index 779af339cb72..036d3d589dfa 100644 --- a/content/developers/apps/making-a-github-app-public-or-private.md +++ b/content/developers/apps/making-a-github-app-public-or-private.md @@ -17,7 +17,7 @@ For authentication information, see "[Authenticating with GitHub Apps](/apps/bui ### Public installation flow -Public installation flows have a landing page where users begin the installation flow. This link is provided in the "Public link" field when setting up your GitHub App. For more information, see "[Installing GitHub Apps](/apps/installing-github-apps/)." +Public installation flows have a landing page to enable other people besides the app owner to install the app in their repositories. This link is provided in the "Public link" field when setting up your GitHub App. For more information, see "[Installing GitHub Apps](/apps/installing-github-apps/)." ### Private installation flow diff --git a/content/developers/apps/scopes-for-oauth-apps.md b/content/developers/apps/scopes-for-oauth-apps.md index 29a3c06f2fb7..366efeb18ba2 100644 --- a/content/developers/apps/scopes-for-oauth-apps.md +++ b/content/developers/apps/scopes-for-oauth-apps.md @@ -38,19 +38,19 @@ X-Accepted-OAuth-Scopes: user ### Available scopes Name | Description ------|-----------| -**`(no scope)`** | Grants read-only access to public information (includes public user profile info, public repository info, and gists){% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} +-----|-----------|{% if currentVersion != "github-ae@latest" %} +**`(no scope)`** | Grants read-only access to public information (including user profile info, repository info, and gists){% endif %}{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} **`site_admin`** | Grants site administrators access to [{% data variables.product.prodname_ghe_server %} Administration API endpoints](/rest/reference/enterprise-admin).{% endif %} -**`repo`** | Grants full access to private and public repositories. That includes read/write access to code, commit statuses, repository and organization projects, invitations, collaborators, adding team memberships, deployment statuses, and repository webhooks for public and private repositories and organizations. Also grants ability to manage user projects. - `repo:status`| Grants read/write access to public and private repository commit statuses. This scope is only necessary to grant other users or services access to private repository commit statuses *without* granting access to the code. - `repo_deployment`| Grants access to [deployment statuses](/rest/reference/repos#deployments) for public and private repositories. This scope is only necessary to grant other users or services access to deployment statuses, *without* granting access to the code. - `public_repo`| Limits access to public repositories. That includes read/write access to code, commit statuses, repository projects, collaborators, and deployment statuses for public repositories and organizations. Also required for starring public repositories. +**`repo`** | Grants full access to repositories, including private repositories. That includes read/write access to code, commit statuses, repository and organization projects, invitations, collaborators, adding team memberships, deployment statuses, and repository webhooks for repositories and organizations. Also grants ability to manage user projects. + `repo:status`| Grants read/write access to {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} and private repository commit statuses. This scope is only necessary to grant other users or services access to private repository commit statuses *without* granting access to the code. + `repo_deployment`| Grants access to [deployment statuses](/rest/reference/repos#deployments) for {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} and private repositories. This scope is only necessary to grant other users or services access to deployment statuses, *without* granting access to the code.{% if currentVersion != "github-ae@latest" %} + `public_repo`| Limits access to public repositories. That includes read/write access to code, commit statuses, repository projects, collaborators, and deployment statuses for public repositories and organizations. Also required for starring public repositories.{% endif %}  `repo:invite` | Grants accept/decline abilities for invitations to collaborate on a repository. This scope is only necessary to grant other users or services access to invites *without* granting access to the code.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}  `security_events` | Grants:
read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning)
read and write access to security events in the [{% data variables.product.prodname_secret_scanning %} API](/rest/reference/secret-scanning)
This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %}{% if currentVersion ver_gt "enterprise-server@2.21" and currentVersion ver_lt "enterprise-server@3.1" %}  `security_events` | Grants read and write access to security events in the [{% data variables.product.prodname_code_scanning %} API](/rest/reference/code-scanning). This scope is only necessary to grant other users or services access to security events *without* granting access to the code.{% endif %} -**`admin:repo_hook`** | Grants read, write, ping, and delete access to repository hooks in public and private repositories. The `repo` and `public_repo` scopes grants full access to repositories, including repository hooks. Use the `admin:repo_hook` scope to limit access to only repository hooks. - `write:repo_hook` | Grants read, write, and ping access to hooks in public or private repositories. - `read:repo_hook`| Grants read and ping access to hooks in public or private repositories. +**`admin:repo_hook`** | Grants read, write, ping, and delete access to repository hooks in {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} and private repositories. The `repo` {% if currentVersion != "github-ae@latest" %}and `public_repo` scopes grant{% else %}scope grants{% endif %} full access to repositories, including repository hooks. Use the `admin:repo_hook` scope to limit access to only repository hooks. + `write:repo_hook` | Grants read, write, and ping access to hooks in {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} or private repositories. + `read:repo_hook`| Grants read and ping access to hooks in {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} or private repositories. **`admin:org`** | Fully manage the organization and its teams, projects, and memberships.  `write:org`| Read and write access to organization membership, organization projects, and team membership.  `read:org`| Read-only access to organization membership, organization projects, and team membership. @@ -66,10 +66,10 @@ Name | Description  `user:follow`| Grants access to follow or unfollow other users. **`delete_repo`** | Grants access to delete adminable repositories. **`write:discussion`** | Allows read and write access for team discussions. - `read:discussion` | Allows read access for team discussions.{% if currentVersion == "free-pro-team@latest" %} + `read:discussion` | Allows read access for team discussions.{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" %} **`write:packages`** | Grants access to upload or publish a package in {% data variables.product.prodname_registry %}. For more information, see "[Publishing a package](/github/managing-packages-with-github-packages/publishing-a-package)". **`read:packages`** | Grants access to download or install packages from {% data variables.product.prodname_registry %}. For more information, see "[Installing a package](/github/managing-packages-with-github-packages/installing-a-package)". -**`delete:packages`** | Grants access to delete packages from {% data variables.product.prodname_registry %}. For more information, see "[Deleting packages](/packages/learn-github-packages/deleting-and-restoring-a-package)".{% endif %} +**`delete:packages`** | Grants access to delete packages from {% data variables.product.prodname_registry %}. For more information, see "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}."{% endif %} **`admin:gpg_key`** | Fully manage GPG keys.  `write:gpg_key`| Create, list, and view details for GPG keys.  `read:gpg_key`| List and view details for GPG keys.{% if currentVersion == "free-pro-team@latest" %} @@ -78,11 +78,11 @@ Name | Description {% note %} **Note:** Your OAuth App can request the scopes in the initial redirection. You -can specify multiple scopes by separating them with a space: +can specify multiple scopes by separating them with a space using `%20`: https://github.com/login/oauth/authorize? client_id=...& - scope=user%20public_repo + scope=user%20repo_deployment {% endnote %} diff --git a/content/developers/apps/setting-up-your-development-environment-to-create-a-github-app.md b/content/developers/apps/setting-up-your-development-environment-to-create-a-github-app.md index 0c32f55b6c9f..3384a0020853 100644 --- a/content/developers/apps/setting-up-your-development-environment-to-create-a-github-app.md +++ b/content/developers/apps/setting-up-your-development-environment-to-create-a-github-app.md @@ -420,7 +420,7 @@ Here are a few common problems and some suggested solutions. If you run into any * **Q:** My server isn't listening to events! The Smee client is running in a Terminal window, and I'm installing the app on a repository on GitHub, but I don't see any output in the Terminal window where I'm running the server. - **A:** You may not be running the Smee client, or you may not have the correct Smee domain in your GitHub App settings. First check to make sure the Smee client is running in a Terminal tab. If that's not the problem, visit your [app settings page](https://github.com/settings/apps) and check the fields shown in "[Step 2. Register a new GitHub App](#step-2-register-a-new-github-app)." Make sure the domain in those fields matches the domain you used in your `smee -u ` command in "[Step 1. Start a new Smee channel](#step-1-start-a-new-smee-channel)." + **A:** You may not be running the Smee client, running the Smee command with the wrong parameters or you may not have the correct Smee domain in your GitHub App settings. First check to make sure the Smee client is running in a Terminal tab. If that's not the problem, visit your [app settings page](https://github.com/settings/apps) and check the fields shown in "[Step 2. Register a new GitHub App](#step-2-register-a-new-github-app)." Make sure the domain in those fields matches the domain you used in your `smee -u ` command in "[Step 1. Start a new Smee channel](#step-1-start-a-new-smee-channel)." If none of the above work, check that you are running the full Smee command including the `--path` and `--port` options, for example: `smee --url https://smee.io/qrfeVRbFbffd6vD --path /event_handler --port 3000` (replacing `https://smee.io/qrfeVRbFbffd6vD` with your own Smee domain). * **Q:** I'm getting an `Octokit::NotFound` 404 error in my debug output: ``` diff --git a/content/developers/apps/using-content-attachments.md b/content/developers/apps/using-content-attachments.md index 3bbe27bf11f4..ed9e9fde07dc 100644 --- a/content/developers/apps/using-content-attachments.md +++ b/content/developers/apps/using-content-attachments.md @@ -77,7 +77,7 @@ For more information about creating an installation token, see "[Authenticating **Step 5.** You'll see the new content attachment appear under the link in a pull request or issue comment: -![Content attached to a reference in an issue](/assets/images/github-apps/github_apps_content_reference_attachment.png) +![Content attached to a reference in an issue](/assets/images/github-apps/content_reference_attachment.png) ### Using content attachments in GraphQL We provide the `node_id` in the [`content_reference` webhook](/webhooks/event-payloads/#content_reference) event so you can refer to the `createContentAttachment` mutation in the GraphQL API. @@ -175,4 +175,4 @@ To create a Probot App, follow these steps: 7. Add a comment to the issue you opened that includes the URL you configured in the `app.yml` file. 8. Take a look at the issue comment and you'll see an update that looks like this: - ![Content attached to a reference in an issue](/assets/images/github-apps/github_apps_content_reference_attachment.png) + ![Content attached to a reference in an issue](/assets/images/github-apps/content_reference_attachment.png) diff --git a/content/developers/overview/secret-scanning.md b/content/developers/overview/secret-scanning.md index f45b2d97e7c0..278f89e67288 100644 --- a/content/developers/overview/secret-scanning.md +++ b/content/developers/overview/secret-scanning.md @@ -278,6 +278,48 @@ openssl_key = OpenSSL::PKey::EC.new(current_key) puts openssl_key.verify(OpenSSL::Digest::SHA256.new, Base64.decode64(signature), payload.chomp) ``` +**Validation sample in JavaScript** +```js +const crypto = require("crypto"); +const axios = require("axios"); + +const GITHUB_KEYS_URI = "https://api.github.com/meta/public_keys/secret_scanning"; + +/** + * Verify a payload and signature against a public key + * @param {String} payload the value to verify + * @param {String} signature the expected value + * @param {String} keyID the id of the key used to generated the signature + * @return {void} throws if the signature is invalid + */ +const verify_signature = async (payload, signature, keyID) => { + if (typeof payload !== "string" || payload.length === 0) { + throw new Error("Invalid payload"); + } + if (typeof signature !== "string" || signature.length === 0) { + throw new Error("Invalid signature"); + } + if (typeof keyID !== "string" || keyID.length === 0) { + throw new Error("Invalid keyID"); + } + + const keys = (await axios.get(GITHUB_KEYS_URI)).data; + if (!(keys?.public_keys instanceof Array) || keys.length === 0) { + throw new Error("No public keys found"); + } + + const publicKey = keys.public_keys.find((k) => k.key_identifier === keyID) ?? null; + if (publicKey === null) { + throw new Error("No public key found matching key identifier"); + } + + const verify = crypto.createVerify("SHA256").update(payload); + if (!verify.verify(publicKey.key, Buffer.from(signature, "base64"), "base64")) { + throw new Error("Signature does not match payload"); + } +}; +``` + #### Implement secret revocation and user notification in your secret alert service For {% data variables.product.prodname_secret_scanning %} in public repositories, you can enhance your secret alert service to revoke the exposed secrets and notify the affected users. How you implement this in your secret alert service is up to you, but we recommend considering any secrets that {% data variables.product.prodname_dotcom %} sends you messages about as public and compromised. diff --git a/content/developers/webhooks-and-events/github-event-types.md b/content/developers/webhooks-and-events/github-event-types.md index 788e444783b8..72098b42fa5d 100644 --- a/content/developers/webhooks-and-events/github-event-types.md +++ b/content/developers/webhooks-and-events/github-event-types.md @@ -51,7 +51,7 @@ Link: ; rel="next", [ { "type": "WatchEvent", - "public": true, + "public": false, "payload": { }, "repo": { @@ -162,14 +162,14 @@ Link: ; rel="next", {% data reusables.webhooks.member_event_api_properties %} {% data reusables.webhooks.member_properties %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} ### PublicEvent {% data reusables.webhooks.public_short_desc %} - #### Event `payload` object This event returns an empty `payload` object. - +{% endif %} ### PullRequestEvent {% data reusables.webhooks.pull_request_short_desc %} diff --git a/content/developers/webhooks-and-events/issue-event-types.md b/content/developers/webhooks-and-events/issue-event-types.md index 3341f6ce6a5c..9da44234bd73 100644 --- a/content/developers/webhooks-and-events/issue-event-types.md +++ b/content/developers/webhooks-and-events/issue-event-types.md @@ -163,7 +163,7 @@ Name | Type | Description `tree` | `object` | The Git tree of the commit. `message` | `string` | The commit message. `parents` | `array of objects` | A list of parent commits. -`verfication` | `object` | The result of verifying the commit's signature. For more information, see "[Signature verification object](/rest/reference/git#signature-verification-object)." +`verfication` | `object` | The result of verifying the commit's signature. For more information, see "[Signature verification object](/rest/reference/git#get-a-commit)." `event` | `string` | The event value is `"committed"`. ### connected diff --git a/content/developers/webhooks-and-events/webhook-events-and-payloads.md b/content/developers/webhooks-and-events/webhook-events-and-payloads.md index 75cbee7e0b83..f55db93d4da5 100644 --- a/content/developers/webhooks-and-events/webhook-events-and-payloads.md +++ b/content/developers/webhooks-and-events/webhook-events-and-payloads.md @@ -145,7 +145,7 @@ Also, the `User-Agent` for the requests will have the prefix `GitHub-Hookshot/`. {{ webhookPayloadsForCurrentVersion.check_suite.completed }} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} ### code_scanning_alert {% data reusables.webhooks.code_scanning_alert_event_short_desc %} @@ -705,6 +705,10 @@ Key | Type | Description {{ webhookPayloadsForCurrentVersion.org_block.blocked }} +{% endif %} + +{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" %} + ### package Activity related to {% data variables.product.prodname_registry %}. {% data reusables.webhooks.action_type_desc %} For more information, see "[Managing packages with {% data variables.product.prodname_registry %}](/github/managing-packages-with-github-packages)" to learn more about {% data variables.product.prodname_registry %}. @@ -843,10 +847,10 @@ Key | Type | Description {{ webhookPayloadsForCurrentVersion.project.created }} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" %} ### public {% data reusables.webhooks.public_short_desc %} - #### Availability - Repository webhooks @@ -865,7 +869,7 @@ Key | Type | Description #### Webhook payload example {{ webhookPayloadsForCurrentVersion.public }} - +{% endif %} ### pull_request {% data reusables.webhooks.pull_request_short_desc %} diff --git a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/why-wasnt-my-application-for-a-student-developer-pack-approved.md b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/why-wasnt-my-application-for-a-student-developer-pack-approved.md index 3c0bd5b465f8..e9994f2c8a20 100644 --- a/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/why-wasnt-my-application-for-a-student-developer-pack-approved.md +++ b/content/education/explore-the-benefits-of-teaching-and-learning-with-github-education/why-wasnt-my-application-for-a-student-developer-pack-approved.md @@ -19,7 +19,9 @@ versions: ### Unclear academic affiliation documents -If the image you uploaded doesn't clearly identify your current academic status, we require further proof of your academic status. {% data reusables.education.upload-proof-reapply %} +If the dates or schedule mentioned in your uploaded image do not match our eligibility criteria, we require further proof of your academic status. + +If the image you uploaded doesn't clearly identify your current academic status or if the uploaded image is blurry, we require further proof of your academic status. {% data reusables.education.upload-proof-reapply %} {% data reusables.education.pdf-support %} @@ -58,6 +60,7 @@ For more information, see: You're ineligible for a {% data variables.product.prodname_student_pack %} if: - You're enrolled in an informal learning program that is not part of the [{% data variables.product.prodname_dotcom %} Campus Program](https://education.github.com/schools) and not enrolled in a degree or diploma granting course of study. +- You're pursuing a degree which will be terminated in the current academic session. - You're under 13 years old. Your instructor may still apply for a {% data variables.product.prodname_education %} discount for classroom use. If you're a student at a coding school or bootcamp, you will become eligible for a {% data variables.product.prodname_student_pack %} if your school joins the [{% data variables.product.prodname_dotcom %} Campus Program](https://education.github.com/schools). diff --git a/content/github/administering-a-repository/about-secret-scanning.md b/content/github/administering-a-repository/about-secret-scanning.md index a1572c777148..2365ac5f5844 100644 --- a/content/github/administering-a-repository/about-secret-scanning.md +++ b/content/github/administering-a-repository/about-secret-scanning.md @@ -9,6 +9,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=3.0' + github-ae: '*' --- {% data reusables.secret-scanning.beta %} @@ -35,7 +36,7 @@ When {% data variables.product.prodname_secret_scanning %} detects a set of cred ### About {% data variables.product.prodname_secret_scanning %} for private repositories {% endif %} -{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ### About {% data variables.product.prodname_secret_scanning %} on {% data variables.product.product_name %} {% data variables.product.prodname_secret_scanning_caps %} is available on all organization-owned repositories as part of {% data variables.product.prodname_GH_advanced_security %}. It is not available on user-owned repositories. diff --git a/content/github/administering-a-repository/about-securing-your-repository.md b/content/github/administering-a-repository/about-securing-your-repository.md index 50fbe4f3dd81..e383cbb71e69 100644 --- a/content/github/administering-a-repository/about-securing-your-repository.md +++ b/content/github/administering-a-repository/about-securing-your-repository.md @@ -3,7 +3,8 @@ title: About securing your repository intro: '{% data variables.product.product_name %} provides a number of ways that you can help keep your repository secure.' versions: free-pro-team: '*' - enterprise-server: '>=3.0' + enterprise-server: '>=3.0' + github-ae: '*' --- ### Setting up your repository securely @@ -14,6 +15,7 @@ The first step to securing a repository is to set up who can see and modify your {% data variables.product.prodname_dotcom %} has a growing set of security features that help you keep your code secure. You can find these on the **Security** tab for your repository. +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} #### Available for all repositories {% if currentVersion == "free-pro-team@latest" %} @@ -31,7 +33,7 @@ The first step to securing a repository is to set up who can see and modify your and "[About {% data variables.product.prodname_dependabot_security_updates %}](/github/managing-security-vulnerabilities/about-dependabot-security-updates)." {% endif %} -{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion ver_gt "enterprise-server@2.22" %} - **{% data variables.product.prodname_dependabot_alerts %}** View alerts about dependencies that are known to contain security vulnerabilities, and manage these alerts. For more information, see "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)." @@ -42,12 +44,15 @@ The first step to securing a repository is to set up who can see and modify your Use {% data variables.product.prodname_dependabot %} to automatically raise pull requests to keep your dependencies up-to-date. This helps reduce your exposure to older versions of dependencies. Using newer versions makes it easier to apply patches if security vulnerabilities are discovered, and also makes it easier for {% data variables.product.prodname_dependabot_security_updates %} to successfully raise pull requests to upgrade vulnerable dependencies. For more information, see "[About {% data variables.product.prodname_dependabot_version_updates %}](/github/administering-a-repository/about-dependabot-version-updates)." {% endif %} + {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} #### Available {% if currentVersion == "free-pro-team@latest" %}for public repositories and for repositories {% endif %}with {% data variables.product.prodname_advanced_security %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} These features are available {% if currentVersion == "free-pro-team@latest" %}for all public repositories, and for private repositories owned by organizations with {% else %}if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. {% data reusables.advanced-security.more-info-ghas %} + {% endif %} - **{% data variables.product.prodname_code_scanning_capc %} alerts** @@ -55,7 +60,7 @@ These features are available {% if currentVersion == "free-pro-team@latest" %}fo - **Detected secrets** - {% if currentVersion == "free-pro-team@latest" %}For private repositories, view {% else if %}View {% endif %}any secrets that {% data variables.product.prodname_dotcom %} has found in your code. You should treat tokens or credentials that have been checked into the repository as compromised. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." + {% if currentVersion == "free-pro-team@latest" %}For private repositories, view {% else %}View {% endif %}any secrets that {% data variables.product.prodname_dotcom %} has found in your code. You should treat tokens or credentials that have been checked into the repository as compromised. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." {% endif %} @@ -63,6 +68,7 @@ These features are available {% if currentVersion == "free-pro-team@latest" %}fo - **Dependency review** - Show the full impact of changes to dependencies and see details of any vulnerable versions before you merge a pull request. For more information, see "[Reviewing dependency changes in a pull request](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request)." {% endif %} +{% if currentVersion != "github-ae@latest" %} ### Exploring dependencies {% data variables.product.prodname_dotcom %}'s dependency graph allows you to explore: @@ -72,3 +78,4 @@ These features are available {% if currentVersion == "free-pro-team@latest" %}fo You must enable the dependency graph before {% data variables.product.prodname_dotcom %} can generate {% data variables.product.prodname_dependabot_alerts %} for dependencies with security vulnerabilities. {% if currentVersion == "free-pro-team@latest" %}Enabling the dependency graph also enables {% data variables.product.prodname_dotcom %} to run dependency reviews of pull requests.{% endif %} You can find the dependency graph on the **Insights** tab for your repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." +{% endif %} diff --git a/content/github/administering-a-repository/configuring-secret-scanning-for-your-repositories.md b/content/github/administering-a-repository/configuring-secret-scanning-for-your-repositories.md index b4c714924d40..27105cdd2f2a 100644 --- a/content/github/administering-a-repository/configuring-secret-scanning-for-your-repositories.md +++ b/content/github/administering-a-repository/configuring-secret-scanning-for-your-repositories.md @@ -7,7 +7,8 @@ redirect_from: product: '{% data reusables.gated-features.secret-scanning %}' versions: free-pro-team: '*' - enterprise-server: '>=3.0' + enterprise-server: '>=3.0' + github-ae: '*' --- {% data reusables.secret-scanning.beta %} @@ -26,7 +27,6 @@ versions: {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-security-and-analysis %} - {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} 4. You may need to enable {% data variables.product.prodname_GH_advanced_security %} to activate the button for "{% data variables.product.prodname_secret_scanning_caps %}". To the right of "{% data variables.product.prodname_GH_advanced_security %}", click **Enable**. ![Enable {% data variables.product.prodname_GH_advanced_security %} for your repository](/assets/images/help/repository/enable-ghas-dotcom.png) @@ -34,10 +34,18 @@ versions: ![Confirm enabling {% data variables.product.prodname_GH_advanced_security %} for your repository](/assets/images/help/repository/enable-ghas-confirmation-dotcom.png) 6. When you enable {% data variables.product.prodname_GH_advanced_security %} this may automatically enable {% data variables.product.prodname_secret_scanning %} for the repository (this is controlled by the organization configuration). If "{% data variables.product.prodname_secret_scanning_caps %}" is shown with an **Enable** button, you still need to enable {% data variables.product.prodname_secret_scanning %} by clicking **Enable**. If you see a **Disable** button, {% data variables.product.prodname_secret_scanning %} is already enabled. ![Enable {% data variables.product.prodname_secret_scanning %} for your repository](/assets/images/help/repository/enable-secret-scanning-dotcom.png) - {% else if enterpriseServerVersions contains currentVersion and currentVersion == "enterprise-server@3.0" %} -4. To the right of "{% data variables.product.prodname_secret_scanning_caps %}", click **Enable**. + {% elsif currentVersion == "enterprise-server@3.0" %} +7. To the right of "{% data variables.product.prodname_secret_scanning_caps %}", click **Enable**. ![Enable {% data variables.product.prodname_secret_scanning %} for your repository](/assets/images/help/repository/enable-secret-scanning-ghe.png) {% endif %} +{% if currentVersion == "github-ae@latest" %} +1. Before you can enable {% data variables.product.prodname_secret_scanning %}, you need to enable {% data variables.product.prodname_GH_advanced_security %} first. To the right of "{% data variables.product.prodname_GH_advanced_security %}", click **Enable**. + ![Enable {% data variables.product.prodname_GH_advanced_security %} for your repository](/assets/images/enterprise/github-ae/repository/enable-ghas-ghae.png) +2. Click **Enable {% data variables.product.prodname_GH_advanced_security %} for this repository** to confirm the action. + ![Confirm enabling {% data variables.product.prodname_GH_advanced_security %} for your repository](/assets/images/enterprise/github-ae/repository/enable-ghas-confirmation-ghae.png) +3. To the right of "{% data variables.product.prodname_secret_scanning_caps %}", click **Enable**. + ![Enable {% data variables.product.prodname_secret_scanning %} for your repository](/assets/images/enterprise/github-ae/repository/enable-secret-scanning-ghae.png) +{% endif %} ### Excluding alerts from {% data variables.product.prodname_secret_scanning %} in {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repositories diff --git a/content/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository.md b/content/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository.md index c759845dad4e..8c100e064bce 100644 --- a/content/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository.md +++ b/content/github/administering-a-repository/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-repository.md @@ -4,6 +4,7 @@ intro: 'You can configure the retention period for {% data variables.product.pro versions: free-pro-team: '*' enterprise-server: '>=2.23' + github-ae: '*' --- {% data reusables.actions.about-artifact-log-retention %} diff --git a/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md b/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md index 3ae328181f75..4027f7cfc16e 100644 --- a/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md +++ b/content/github/administering-a-repository/disabling-or-limiting-github-actions-for-a-repository.md @@ -4,6 +4,7 @@ intro: 'Repository owners can disable, enable, and limit {% data variables.produ versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} diff --git a/content/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository.md b/content/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository.md index f49eb6231fa2..4edba4ddedd8 100644 --- a/content/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository.md +++ b/content/github/administering-a-repository/displaying-a-sponsor-button-in-your-repository.md @@ -16,7 +16,7 @@ You can add one username, package name, or project name per external funding pla Platform | Syntax -------- | ----- -[CommunityBridge](https://communitybridge.org) | `community_bridge: PROJECT-NAME` +[LFX Mentorship (formerly CommunityBridge)](https://lfx.linuxfoundation.org/tools/mentorship) | `community_bridge: PROJECT-NAME` [{% data variables.product.prodname_sponsors %}](https://github.com/sponsors) | `github: USERNAME` or `github: [USERNAME, USERNAME, USERNAME, USERNAME]` [IssueHunt](https://issuehunt.io/) | `issuehunt: USERNAME` [Ko-fi](https://ko-fi.com/) | `ko_fi: USERNAME` diff --git a/content/github/administering-a-repository/managing-alerts-from-secret-scanning.md b/content/github/administering-a-repository/managing-alerts-from-secret-scanning.md index a25d4ef0641a..d6c7398e9837 100644 --- a/content/github/administering-a-repository/managing-alerts-from-secret-scanning.md +++ b/content/github/administering-a-repository/managing-alerts-from-secret-scanning.md @@ -5,6 +5,7 @@ product: '{% data reusables.gated-features.secret-scanning %}' versions: free-pro-team: '*' enterprise-server: '>=3.0' + github-ae: '*' --- {% data reusables.secret-scanning.beta %} @@ -13,20 +14,28 @@ versions: {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} -3. In the left sidebar, click **Detected secrets**. -!["Detected secrets" tab](/assets/images/help/repository/sidebar-secrets.png) +3. In the left sidebar, click **Secret scanning alerts**. + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} + !["Secret scanning alerts" tab](/assets/images/help/repository/sidebar-secrets.png) + {% endif %} + {% if currentVersion == "github-ae@latest" %} + !["Secret scanning alerts" tab](/assets/images/enterprise/github-ae/repository/sidebar-secrets-ghae.png) + {% endif %} 4. Under "Secret scanning" click the alert you want to view. {% if currentVersion == "free-pro-team@latest" %} ![List of alerts from secret scanning](/assets/images/help/repository/secret-scanning-click-alert.png) {% endif %} - {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} + {% if currentVersion ver_gt "enterprise-server@2.22" %} ![List of alerts from secret scanning](/assets/images/help/repository/secret-scanning-click-alert-ghe.png) {% endif %} -1. Optionally, use the "Mark as" drop-down menu and click a reason for resolving an alert. + {% if currentVersion == "github-ae@latest" %} + ![List of alerts from secret scanning](/assets/images/enterprise/github-ae/repository/secret-scanning-click-alert-ghae.png) + {% endif %} +5. Optionally, use the "Mark as" drop-down menu and click a reason for resolving an alert. {% if currentVersion == "free-pro-team@latest" %} ![Drop-down menu for resolving an alert from secret scanning](/assets/images/help/repository/secret-scanning-resolve-alert.png) {% endif %} - {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} + {% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ![Drop-down menu for resolving an alert from secret scanning](/assets/images/help/repository/secret-scanning-resolve-alert-ghe.png) {% endif %} diff --git a/content/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository.md b/content/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository.md index f8c0730a6b12..1b768465bb93 100644 --- a/content/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository.md +++ b/content/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository.md @@ -10,6 +10,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=3.0' + github-ae: '*' --- {% if currentVersion == "free-pro-team@latest" %} @@ -26,31 +27,38 @@ You can manage a subset of security and analysis features for public repositorie ### Enabling or disabling security and analysis features{% if currentVersion == "free-pro-team@latest" %} for private repositories{% endif %} -You can manage the security and analysis features for your {% if currentVersion == "free-pro-team@latest" %}private or internal {% endif %}repository. If your organization or enterprise has a license for {% data variables.product.prodname_GH_advanced_security %} then extra options are available. {% data reusables.advanced-security.more-info-ghas %} +You can manage the security and analysis features for your {% if currentVersion == "free-pro-team@latest" %}private or internal {% endif %}repository.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} If your organization or enterprise has a license for {% data variables.product.prodname_GH_advanced_security %} then extra options are available. {% data reusables.advanced-security.more-info-ghas %}{% endif %} {% data reusables.security.security-and-analysis-features-enable-read-only %} {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-settings %} {% data reusables.repositories.navigate-to-security-and-analysis %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} 4. Under "Configure security and analysis features", to the right of the feature, click **Disable** or **Enable**. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}If the control for "{% data variables.product.prodname_secret_scanning_caps %}" is not active, you need to enable {% data variables.product.prodname_GH_advanced_security %} first. !["Enable" or "Disable" button for "Configure security and analysis" features](/assets/images/help/repository/security-and-analysis-disable-or-enable-dotcom-private.png) {% note %} **Note:** If you disable {% data variables.product.prodname_GH_advanced_security %}, both {% data variables.product.prodname_secret_scanning %} and {% data variables.product.prodname_code_scanning %} are disabled. Any workflows, SARIF uploads, or API calls for {% data variables.product.prodname_code_scanning %} will fail. {% endnote %} - - {% else if enterpriseServerVersions contains currentVersion and currentVersion == "enterprise-server@3.0" %} + {% endif %} + {% endif %} + {% if currentVersion == "enterprise-server@3.0" %} !["Enable" or "Disable" button for "Configure security and analysis" features](/assets/images/help/repository/security-and-analysis-disable-or-enable-ghe.png) {% endif %} + {% if currentVersion == "github-ae@latest" %} +4. Under "Configure security and analysis features", to the right of the feature, click **Disable** or **Enable**. Before you can enable "{% data variables.product.prodname_secret_scanning %}" for your repository, you need to enable {% data variables.product.prodname_GH_advanced_security %}. + ![Enable or disable {% data variables.product.prodname_GH_advanced_security %} or {% data variables.product.prodname_secret_scanning %} for your repository](/assets/images/enterprise/github-ae/repository/enable-ghas-secret-scanning-ghae.png) + {% endif %} + ### Granting access to security alerts -After you enable {% data variables.product.prodname_dependabot %} or {% data variables.product.prodname_secret_scanning %} alerts for a repository in an organization, organization owners and repository administrators can view the alerts by default. You can give additional teams and people access to the alerts for a repository. +After you enable {% if currentVersion != "github-ae@latest" %}{% data variables.product.prodname_dependabot %} or {% endif %}{% data variables.product.prodname_secret_scanning %} alerts for a repository in an organization, organization owners and repository administrators can view the alerts by default. You can give additional teams and people access to the alerts for a repository. {% note %} -Organization owners and repository administrators can only grant access to view security alerts, such as {% data variables.product.prodname_dependabot %} and {% data variables.product.prodname_secret_scanning %} alerts, to people or teams who have write access to the repo. +Organization owners and repository administrators can only grant access to view security alerts, such as {% data variables.product.prodname_secret_scanning %} alerts, to people or teams who have write access to the repo. {% endnote %} @@ -64,8 +72,17 @@ Organization owners and repository administrators can only grant access to view {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} ![Search field for granting people or teams access to security alerts](/assets/images/help/repository/security-and-analysis-security-alerts-person-or-team-search-ghe.png) {% endif %} + {% if currentVersion == "github-ae@latest" %} + ![Search field for granting people or teams access to security alerts](/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-person-or-team-search-ghae.png) + {% endif %} + 5. Click **Save changes**. - !["Save changes" button for changes to security alert settings](/assets/images/help/repository/security-and-analysis-security-alerts-save-changes.png) + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} + !["Save changes" button for changes to security alert settings](/assets/images/help/repository/security-and-analysis-security-alerts-save-changes.png) + {% endif %} + {% if currentVersion == "github-ae@latest" %} + !["Save changes" button for changes to security alert settings](/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-save-changes-ghae.png) + {% endif %} ### Removing access to security alerts @@ -79,6 +96,9 @@ Organization owners and repository administrators can only grant access to view {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} !["x" button to remove someone's access to security alerts for your repository](/assets/images/help/repository/security-and-analysis-security-alerts-username-x-ghe.png) {% endif %} + {% if currentVersion == "github-ae@latest" %} + !["x" button to remove someone's access to security alerts for your repository](/assets/images/enterprise/github-ae/repository/security-and-analysis-security-alerts-username-x-ghae.png) + {% endif %} ### Further reading diff --git a/content/github/administering-a-repository/securing-your-repository.md b/content/github/administering-a-repository/securing-your-repository.md index df0cafb2175e..73f4af51ea0a 100644 --- a/content/github/administering-a-repository/securing-your-repository.md +++ b/content/github/administering-a-repository/securing-your-repository.md @@ -7,5 +7,6 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=3.0' + github-ae: '*' --- diff --git a/content/github/authenticating-to-github/connecting-with-third-party-applications.md b/content/github/authenticating-to-github/connecting-with-third-party-applications.md index 5af7c4e73192..a0e789b8222e 100644 --- a/content/github/authenticating-to-github/connecting-with-third-party-applications.md +++ b/content/github/authenticating-to-github/connecting-with-third-party-applications.md @@ -55,13 +55,13 @@ There are several types of data that applications can request. | Type of data | Description | | --- | --- | | Commit status | You can grant access for a third-party application to report your commit status. Commit status access allows applications to determine if a build is a successful against a specific commit. Applications won't have access to your code, but they can read and write status information against a specific commit. | -| Deployments | Deployment status access allows applications to determine if a deployment is successful against a specific commit for public and private repositories. Applications won't have access to your code. | -| Gists | [Gist](https://gist.github.com) access allows applications to read or write to both your public and secret Gists. | +| Deployments | Deployment status access allows applications to determine if a deployment is successful against a specific commit for a repository. Applications won't have access to your code. | +| Gists | [Gist](https://gist.github.com) access allows applications to read or write to {% if currentVersion != "github-ae@latest" %}both your public and{% else %}both your internal and{% endif %} secret Gists. | | Hooks | [Webhooks](/webhooks) access allows applications to read or write hook configurations on repositories you manage. | | Notifications | Notification access allows applications to read your {% data variables.product.product_name %} notifications, such as comments on issues and pull requests. However, applications remain unable to access anything in your repositories. | | Organizations and teams | Organization and teams access allows apps to access and manage organization and team membership. | | Personal user data | User data includes information found in your user profile, like your name, e-mail address, and location. | -| Repositories | Repository information includes the names of contributors, the branches you've created, and the actual files within your repository. Applications can request access for either public or private repositories on a user-wide level. | +| Repositories | Repository information includes the names of contributors, the branches you've created, and the actual files within your repository. Applications can request access for either {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} or private repositories on a user-wide level. | | Repository delete | Applications can request to delete repositories that you administer, but they won't have access to your code. | ### Requesting updated permissions diff --git a/content/github/authenticating-to-github/creating-a-personal-access-token.md b/content/github/authenticating-to-github/creating-a-personal-access-token.md index a61660cea671..eb78e0548668 100644 --- a/content/github/authenticating-to-github/creating-a-personal-access-token.md +++ b/content/github/authenticating-to-github/creating-a-personal-access-token.md @@ -29,7 +29,11 @@ Personal access tokens (PATs) are an alternative to using passwords for authenti 5. Give your token a descriptive name. ![Token description field](/assets/images/help/settings/token_description.png) 6. Select the scopes, or permissions, you'd like to grant this token. To use your token to access repositories from the command line, select **repo**. + {% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %} ![Selecting token scopes](/assets/images/help/settings/token_scopes.gif) + {% elsif currentVersion == "github-ae@latest" %} + ![Selecting token scopes](/assets/images/enterprise/github-ae/settings/access-token-scopes-for-ghae.png) + {% endif %} 7. Click **Generate token**. ![Generate token button](/assets/images/help/settings/generate_token.png) 8. Click {% octicon "clippy" aria-label="The copy to clipboard icon" %} to copy the token to your clipboard. For security reasons, after you navigate off the page, you will not be able to see the token again.{% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/authenticating-to-github/using-ssh-over-the-https-port.md b/content/github/authenticating-to-github/using-ssh-over-the-https-port.md index 07b84a08978e..ba712f9d7389 100644 --- a/content/github/authenticating-to-github/using-ssh-over-the-https-port.md +++ b/content/github/authenticating-to-github/using-ssh-over-the-https-port.md @@ -33,6 +33,7 @@ To set this in your ssh config, edit the file at `~/.ssh/config`, and add this s Host {% data variables.command_line.codeblock %} Hostname ssh.{% data variables.command_line.codeblock %} Port 443 + User git ``` You can test that this works by connecting once more to {% data variables.product.product_location %}: diff --git a/content/github/creating-cloning-and-archiving-repositories/backing-up-a-repository.md b/content/github/creating-cloning-and-archiving-repositories/backing-up-a-repository.md index 11675d7087a1..ac898cfee55b 100644 --- a/content/github/creating-cloning-and-archiving-repositories/backing-up-a-repository.md +++ b/content/github/creating-cloning-and-archiving-repositories/backing-up-a-repository.md @@ -36,7 +36,5 @@ Once you have {% if enterpriseServerVersions contains currentVersion or currentV {% if currentVersion == "free-pro-team@latest" %} ### Third-party backup tools -A number of self-service tools exist that automate backups of repositories. Unlike archival projects, which archive _all_ public repositories on {% data variables.product.product_name %} that have not opted out and make the data accessible to anyone, backup tools will download data from _specific_ repositories and organize it within a new branch or directory. For more information about archival projects, see "[About archiving content and data on {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)." - -You can back up all of a repository's Git data (such as project files and commit history), as well as much data from {% data variables.product.product_name %} (such as issues and pull requests), with [BackHub](https://github.com/marketplace/backhub), which creates daily recurring backups of your repositories with snapshots up to 30 days back in time. BackHub is available in {% data variables.product.prodname_marketplace %}. +A number of self-service tools exist that automate backups of repositories. Unlike archival projects, which archive _all_ public repositories on {% data variables.product.product_name %} that have not opted out and make the data accessible to anyone, backup tools will download data from _specific_ repositories and organize it within a new branch or directory. For more information about archival projects, see "[About archiving content and data on {% data variables.product.prodname_dotcom %}](/github/creating-cloning-and-archiving-repositories/about-archiving-content-and-data-on-github#about-the-github-archive-program)." For more information about self-service backup tools, see the [Backup Utilities category on {% data variables.product.prodname_marketplace %}](https://github.com/marketplace?category=backup-utilities). {% endif %} diff --git a/content/github/creating-cloning-and-archiving-repositories/licensing-a-repository.md b/content/github/creating-cloning-and-archiving-repositories/licensing-a-repository.md index e4619e0a4c95..0110416cc7c3 100644 --- a/content/github/creating-cloning-and-archiving-repositories/licensing-a-repository.md +++ b/content/github/creating-cloning-and-archiving-repositories/licensing-a-repository.md @@ -23,7 +23,7 @@ You're under no obligation to choose a license. However, without a license, the ### Determining the location of your license -Most people place their license text in a file named `LICENSE.txt` (or `LICENSE.md`) in the root of the repository; [here's an example from Hubot](https://github.com/github/hubot/blob/master/LICENSE.md). +Most people place their license text in a file named `LICENSE.txt` (or `LICENSE.md` or `LICENSE.rst`) in the root of the repository; [here's an example from Hubot](https://github.com/github/hubot/blob/master/LICENSE.md). Some projects include information about their license in their README. For example, a project's README may include a note saying "This project is licensed under the terms of the MIT license." diff --git a/content/github/customizing-your-github-workflow/github-extensions-and-integrations.md b/content/github/customizing-your-github-workflow/github-extensions-and-integrations.md index 9d49e1b75b5e..024170319441 100644 --- a/content/github/customizing-your-github-workflow/github-extensions-and-integrations.md +++ b/content/github/customizing-your-github-workflow/github-extensions-and-integrations.md @@ -30,12 +30,20 @@ With the {% data variables.product.prodname_dotcom %} for Visual Studio Code ext ### Project management tools -You can integrate your {% data variables.product.product_name %} personal account or organization with third-party project management tools, such as Jira or Slack. +You can integrate your {% data variables.product.product_name %} personal account or organization with third-party project management tools, such as Jira. #### Jira Cloud and {% data variables.product.product_name %}.com integration You can integrate Jira Cloud with your personal or organization account to scan commits and pull requests, creating relevant metadata and hyperlinks in any mentioned Jira issues. For more information, visit the [Jira integration app](https://github.com/marketplace/jira-software-github) in the marketplace. +### Team communication tools + +You can integrate your {% data variables.product.product_name %} personal account or organization with third-party team communication tools, such as Slack or Microsoft Teams. + #### Slack and {% data variables.product.product_name %} integration You can integrate Slack with your personal or organization account to subscribe for notifications, close or open issues, and provide rich references to issues and pull requests without leaving Slack. For more information, visit the [Slack integration app](https://github.com/marketplace/slack-github) in the marketplace. + +#### Microsoft Teams and {% data variables.product.product_name %} integration + +You can integrate Microsoft Teams with your personal or organization account to access information about {% data variables.product.product_name %} alongside wider team communication. When you integrate Microsoft Teams with {% data variables.product.product_name %}, you can subscribe for notifications, close or open issues, and provide rich references to issues and pull requests without leaving Microsoft Teams. For more information, visit the [Microsoft Teams integration app](https://appsource.microsoft.com/en-us/product/office/WA200002077) in Microsoft AppSource. diff --git a/content/github/developing-online-with-codespaces/about-codespaces.md b/content/github/developing-online-with-codespaces/about-codespaces.md index 2413aeac6d41..c711a287630b 100644 --- a/content/github/developing-online-with-codespaces/about-codespaces.md +++ b/content/github/developing-online-with-codespaces/about-codespaces.md @@ -56,4 +56,4 @@ A limited number of people will be invited to join the beta. To join the waitlis If you encounter problems using {% data variables.product.prodname_codespaces %}, see "[Troubleshooting your codespace](/github/developing-online-with-codespaces/troubleshooting-your-codespace)." -If you still need help or have feedback about {% data variables.product.prodname_codespaces %}, use the [Community Forum](https://github.community/c/codespaces-beta/45). +If you still need help or have feedback about {% data variables.product.prodname_codespaces %}, use the [Codespaces Feedback](https://github.com/github/feedback/discussions/categories/codespaces-feedback) discussion. diff --git a/content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md b/content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md index 4fc3f4126f40..2843a272a729 100644 --- a/content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md +++ b/content/github/developing-online-with-codespaces/managing-encrypted-secrets-for-codespaces.md @@ -12,6 +12,7 @@ versions: {% endnote %} + ### About encrypted secrets for {% data variables.product.prodname_codespaces %} You can add encrypted secrets to your user account that you want to use in your codespaces. For example, you may want to store and access the following sensitive information as encrypted secrets. @@ -24,6 +25,12 @@ You can choose which repositories should have access to each secret. Then, you c ### Adding a secret +{% note %} + +**Note:** Tokens starting with GITHUB_ are reserved + +{% endnote %} + {% data reusables.user_settings.access_settings %} {% data reusables.user_settings.codespaces-tab %} 1. To the right of "Codespaces secrets", click **New secret**. diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning.md index 9684696ef417..93644fd98585 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning.md @@ -7,6 +7,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.code-scanning.beta %} @@ -35,7 +36,7 @@ You can use {% data variables.product.prodname_code_scanning %} with {% data var {% data reusables.code-scanning.supported-languages %} -You can view and contribute to the queries for {% data variables.product.prodname_code_scanning %} in the [`github/codeql`](https://github.com/github/codeql) repository. For more information, see [{% data variables.product.prodname_codeql %} queries](https://help.semmle.com/QL/learn-ql/writing-queries/writing-queries.html) in the {% data variables.product.prodname_codeql %} documentation. +You can view and contribute to the queries for {% data variables.product.prodname_code_scanning %} in the [`github/codeql`](https://github.com/github/codeql) repository. For more information, see [{% data variables.product.prodname_codeql %} queries](https://codeql.github.com/docs/writing-codeql-queries/codeql-queries/) in the {% data variables.product.prodname_codeql %} documentation. {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-integration-with-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-integration-with-code-scanning.md index 87abca9e6d40..0e514fc25e32 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-integration-with-code-scanning.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/about-integration-with-code-scanning.md @@ -6,6 +6,7 @@ product: '{% data reusables.gated-features.code-scanning %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.code-scanning.beta %} @@ -17,7 +18,7 @@ If you use a third-party static analysis tool that can produce results as Static ### Integrations with webhooks -You can use {% data variables.product.prodname_code_scanning %} webhooks to build or set up integrations, such as [{% data variables.product.prodname_github_app %}s](/apps/building-github-apps/) or [{% data variables.product.prodname_oauth_app %}s](/apps/building-oauth-apps/), that subscribe to {% data variables.product.prodname_code_scanning %} events in your repository. For example, you could build an integration that creates an issue on {% data variables.product.product_location %} or sends you a Slack notification when a new {% data variables.product.prodname_code_scanning %} alert is added in your repository. For more information, see "[Creating webhooks](/developers/webhooks-and-events/creating-webhooks)" and "[Webhook events and payloads](/developers/webhooks-and-events/webhook-events-and-payloads#code_scanning_alert)." +You can use {% data variables.product.prodname_code_scanning %} webhooks to build or set up integrations, such as [{% data variables.product.prodname_github_app %}s](/apps/building-github-apps/) or [{% data variables.product.prodname_oauth_app %}s](/apps/building-oauth-apps/), that subscribe to {% data variables.product.prodname_code_scanning %} events in your repository. For example, you could build an integration that creates an issue on {% data variables.product.product_name %} or sends you a Slack notification when a new {% data variables.product.prodname_code_scanning %} alert is added in your repository. For more information, see "[Creating webhooks](/developers/webhooks-and-events/creating-webhooks)" and "[Webhook events and payloads](/developers/webhooks-and-events/webhook-events-and-payloads#code_scanning_alert)." ### Further reading diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors.md index 2f126e4f1c23..d8f88cd46b94 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/automatically-scanning-your-code-for-vulnerabilities-and-errors.md @@ -7,5 +7,6 @@ product: '{% data reusables.gated-features.code-scanning %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md index c0231c0766be..c54a30bb932d 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-code-scanning.md @@ -7,6 +7,7 @@ miniTocMaxHeadingLevel: 4 versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.code-scanning.beta %} @@ -14,9 +15,9 @@ versions: ### About {% data variables.product.prodname_code_scanning %} configuration -You can run {% data variables.product.prodname_code_scanning %} within {% data variables.product.product_location %}, using {% data variables.product.prodname_actions %}, or from your continuous integration (CI) system, using the {% data variables.product.prodname_codeql_runner %}. For more information about {% data variables.product.prodname_actions %}, see "[About {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)." For more information about the {% data variables.product.prodname_codeql_runner %}, see "[Running {% data variables.product.prodname_code_scanning %} in your CI system](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system)." +You can run {% data variables.product.prodname_code_scanning %} on {% data variables.product.product_name %}, using {% data variables.product.prodname_actions %}, or from your continuous integration (CI) system, using the {% data variables.product.prodname_codeql_runner %}. For more information about {% data variables.product.prodname_actions %}, see "[About {% data variables.product.prodname_actions %}](/actions/getting-started-with-github-actions/about-github-actions)." For more information about the {% data variables.product.prodname_codeql_runner %}, see "[Running {% data variables.product.prodname_code_scanning %} in your CI system](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system)." -This article is about running {% data variables.product.prodname_code_scanning %} within {% if currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_ghe_server %}{% else %}{% data variables.product.prodname_dotcom %}{% endif %}. +This article is about running {% data variables.product.prodname_code_scanning %} on {% data variables.product.product_name %}. Before you can configure {% data variables.product.prodname_code_scanning %} for a repository, you must set up {% data variables.product.prodname_code_scanning %} by adding a {% data variables.product.prodname_actions %} workflow to the repository. For more information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository)." @@ -203,13 +204,17 @@ jobs: {% data reusables.code-scanning.run-additional-queries %} -To add one or more queries, add a `with: queries:` entry within the `uses: github/codeql-action/init@v1` section of the workflow. +To add one or more queries, add a `with: queries:` entry within the `uses: github/codeql-action/init@v1` section of the workflow. If the queries are in a private repository, use the `external-repository-token` parameter to specify a token that has access to the private repository. +{% raw %} ``` yaml - uses: github/codeql-action/init@v1 with: queries: COMMA-SEPARATED LIST OF PATHS + # Optional. Provide a token to access private repositories. + external-repository-token: ${{ secrets.ACCESS_TOKEN }} ``` +{% endraw %} You can also specify query suites in the value of `queries`. Query suites are collections of queries, usually grouped by purpose or language. @@ -219,12 +224,15 @@ If you are also using a configuration file for custom settings, any additional q In the following example, the `+` symbol ensures that the specified additional queries are used together with any queries specified in the referenced configuration file. +{% raw %} ``` yaml - uses: github/codeql-action/init@v1 with: config-file: ./.github/codeql/codeql-config.yml queries: +security-and-quality,octo-org/python-qlpack/show_ifs.ql@main + external-repository-token: ${{ secrets.ACCESS_TOKEN }} ``` +{% endraw %} ### Using a custom configuration file @@ -238,9 +246,19 @@ In the workflow file, use the `config-file` parameter of the `init` action to sp config-file: ./.github/codeql/codeql-config.yml ``` -The configuration file can be located within the local repository, or in a remote, public repository. Using a remote, public repository allows you to specify configuration options for multiple repositories in a single place. When you reference a configuration file located in a remote repository, you can use the _OWNER/REPOSITORY/FILENAME@BRANCH_ syntax. For example, _monacorp/shared/codeql-config.yml@main_. +{% data reusables.code-scanning.custom-configuration-file %} + +If the configuration file is located in an external private repository, use the `external-repository-token` parameter of the `init` action to specify a token that has access to the private repository. + +{% raw %} +```yaml +uses: github/codeql-action/init@v1 +with: + external-repository-token: ${{ secrets.ACCESS_TOKEN }} +``` +{% endraw %} -The settings in the file are written in YAML format. +The settings in the configuration file are written in YAML format. #### Specifying additional queries @@ -296,25 +314,6 @@ You can quickly analyze small portions of a monorepo when you modify code in spe {% data reusables.code-scanning.autobuild-add-build-steps %} For more information about how to configure {% data variables.product.prodname_codeql %} {% data variables.product.prodname_code_scanning %} for compiled languages, see "[Configuring the {% data variables.product.prodname_codeql %} workflow for compiled languages](/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages)." -### Accessing private repositories - -If your workflow for {% data variables.product.prodname_code_scanning %} accesses a private repository, other than the repository that contains the workflow, you'll need to configure Git to authenticate with a personal access token. Define the secret in the runner environment by using `jobs..steps[*].env` in your workflow before any {% data variables.product.prodname_codeql %} actions. For more information, see "[Creating a personal access token for the command line](/github/authenticating-to-github/creating-a-personal-access-token-for-the-command-line)" and "[Creating and storing encrypted secrets](/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets)." - -For example, the following configuration has Git replace the full URLs to the `ghost/foo`, `ghost/bar`, and `ghost/baz` repositories on {% data variables.product.prodname_dotcom_the_website %} with URLs that include the personal access token that you store in the `ACCESS_TOKEN` environment variable. - -{% raw %} -```yaml -steps: -- name: Configure access to private repositories - env: - TOKEN: ${{ secrets.ACCESS_TOKEN }} - run: | - git config --global url."https://${TOKEN}@github.com/ghost/foo".insteadOf "https://github.com/ghost/foo" - git config --global url."https://${TOKEN}@github.com/ghost/bar".insteadOf "https://github.com/ghost/bar" - git config --global url."https://${TOKEN}@github.com/ghost/baz".insteadOf "https://github.com/ghost/baz" -``` -{% endraw %} - ### Uploading {% data variables.product.prodname_code_scanning %} data to {% data variables.product.prodname_dotcom %} {% data variables.product.prodname_dotcom %} can display code analysis data generated externally by a third-party tool. You can upload code analysis data with the `upload-sarif` action. For more information, see "[Uploading a SARIF file to GitHub](/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github)." diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-codeql-code-scanning-in-your-ci-system.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-codeql-code-scanning-in-your-ci-system.md index 7a8c9e9014ec..b94bfc2fbaf2 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-codeql-code-scanning-in-your-ci-system.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-codeql-code-scanning-in-your-ci-system.md @@ -9,6 +9,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.code-scanning.beta-codeql-runner %} @@ -85,6 +86,8 @@ Use the `--config-file` flag of the `init` command to specify the configuration $ /path/to-runner/codeql-runner-linux init --config-file .github/codeql/codeql-config.yml ``` +{% data reusables.code-scanning.custom-configuration-file %} + #### Example configuration files {% data reusables.code-scanning.example-configuration-files %} @@ -145,7 +148,7 @@ Attempts to build the code for the compiled languages C/C++, C#, and Java. For t #### `analyze` -Analyzes the code in the {% data variables.product.prodname_codeql %} databases and uploads results to {% data variables.product.product_location %}. +Analyzes the code in the {% data variables.product.prodname_codeql %} databases and uploads results to {% data variables.product.product_name %}. | Flag | Required | Input value | | ---- |:--------:| ----------- | @@ -155,7 +158,7 @@ Analyzes the code in the {% data variables.product.prodname_codeql %} databases | `--github-url` | ✓ | URL of the {% data variables.product.prodname_dotcom %} instance where your repository is hosted. | | `--github-auth` | ✓ | A {% data variables.product.prodname_github_apps %} token or personal access token. | | `--checkout-path` | | The path to the checkout of your repository. The default is the current working directory. | -| `--no-upload` | | None. Stops the {% data variables.product.prodname_codeql_runner %} from uploading the results to {% data variables.product.product_location %}. | +| `--no-upload` | | None. Stops the {% data variables.product.prodname_codeql_runner %} from uploading the results to {% data variables.product.product_name %}. | | `--output-dir` | | Directory where the output SARIF files are stored. The default is in the directory of temporary files. | | `--ram` | | Amount of memory to use when running queries. The default is to use all available memory. | | `--no-add-snippets` | | None. Excludes code snippets from the SARIF output. | @@ -166,7 +169,7 @@ Analyzes the code in the {% data variables.product.prodname_codeql %} databases #### `upload` -Uploads SARIF files to {% data variables.product.product_location %}. +Uploads SARIF files to {% data variables.product.product_name %}. {% note %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages.md index 8dbf60a780a1..3f9ef7ac04ec 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/configuring-the-codeql-workflow-for-compiled-languages.md @@ -10,6 +10,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.code-scanning.beta %} @@ -32,7 +33,10 @@ If your workflow uses a `language` matrix, `autobuild` attempts to build each of {% note %} +{% if currentVersion == "github-ae@latest" %}**Note**: For instructions on how to make sure your {% data variables.actions.hosted_runner %} has the required software installed, see "[Creating custom images](/actions/using-github-hosted-runners/creating-custom-images)." +{% else %} **Note**: If you use self-hosted runners for {% data variables.product.prodname_actions %}, you may need to install additional software to use the `autobuild` process. Additionally, if your repository requires a specific version of a build tool, you may need to install it manually. For more information, see "[Specifications for {% data variables.product.prodname_dotcom %}-hosted runners](/actions/reference/specifications-for-github-hosted-runners/#supported-software)". +{% endif %} {% endnote %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/index.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/index.md index 3c5f11b67803..cf5bc1721e5c 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/index.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/index.md @@ -7,6 +7,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- ### Table of Contents diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning.md index 01a082e5015f..ee5e4671d591 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/integrating-with-code-scanning.md @@ -9,5 +9,6 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository.md index 70a5d289e33f..a72de426b29c 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository.md @@ -7,6 +7,7 @@ permissions: 'If you have write permission to a repository you can manage {% dat versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' redirect_from: - /github/managing-security-vulnerabilities/managing-alerts-from-automated-code-scanning - /github/finding-security-vulnerabilities-and-errors-in-your-code/managing-alerts-from-code-scanning diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md index 8b0021e943c3..a05a2ca34942 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container.md @@ -6,6 +6,7 @@ product: '{% data reusables.gated-features.code-scanning %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.code-scanning.beta %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system.md index 9ae8a2ddf5df..b2ff31219a8e 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-your-ci-system.md @@ -8,6 +8,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- @@ -23,9 +24,9 @@ If you use a continuous integration or continuous delivery/deployment (CI/CD) sy {% data reusables.code-scanning.about-code-scanning %} For information, see "[About {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning)." -You can use the {% data variables.product.prodname_codeql_runner %} to run {% data variables.product.prodname_code_scanning %} on code that you're processing in a third-party continuous integration (CI) system. Alternatively, you can use {% data variables.product.prodname_actions %} to run {% data variables.product.prodname_code_scanning %} on {% data variables.product.product_location %}. For information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository)." +You can use the {% data variables.product.prodname_codeql_runner %} to run {% data variables.product.prodname_code_scanning %} on code that you're processing in a third-party continuous integration (CI) system. Alternatively, you can use {% data variables.product.prodname_actions %} to run {% data variables.product.prodname_code_scanning %} on {% data variables.product.product_name %}. For information, see "[Setting up {% data variables.product.prodname_code_scanning %} for a repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository)." -The {% data variables.product.prodname_codeql_runner %} is a command-line tool that runs {% data variables.product.prodname_codeql %} analysis on a checkout of a {% data variables.product.prodname_dotcom %} repository. You add the runner to your third-party system, then call the runner to analyze code and upload the results to {% data variables.product.product_location %}. These results are displayed as {% data variables.product.prodname_code_scanning %} alerts in the repository. +The {% data variables.product.prodname_codeql_runner %} is a command-line tool that runs {% data variables.product.prodname_codeql %} analysis on a checkout of a {% data variables.product.prodname_dotcom %} repository. You add the runner to your third-party system, then call the runner to analyze code and upload the results to {% data variables.product.product_name %}. These results are displayed as {% data variables.product.prodname_code_scanning %} alerts in the repository. {% note %} @@ -40,7 +41,7 @@ The {% data variables.product.prodname_codeql_runner %} is a command-line tool t ### Downloading the {% data variables.product.prodname_codeql_runner %} -You can download the {% data variables.product.prodname_codeql_runner %} from https://github.com/github/codeql-action/releases. On some operating systems, you may need to change permissions for the downloaded file before you can run it. +You can download the {% data variables.product.prodname_codeql_runner %} from https://{% if currentVersion == "enterprise-server@2.22" or currentVersion == "free-pro-team@latest" %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases. On some operating systems, you may need to change permissions for the downloaded file before you can run it. On Linux: @@ -59,33 +60,33 @@ On Windows, the `codeql-runner-win.exe` file usually requires no change to permi ### Adding the {% data variables.product.prodname_codeql_runner %} to your CI system -Once you download the {% data variables.product.prodname_codeql_runner %} and verify that it can be executed, you should make the runner available to each CI server that you intend to use for {% data variables.product.prodname_code_scanning %}. For example, you might configure each server to copy the runner from a central, internal location. Alternatively, you could use the REST API to get the runner directly from GitHub, for example: +Once you download the {% data variables.product.prodname_codeql_runner %} and verify that it can be executed, you should make the runner available to each CI server that you intend to use for {% data variables.product.prodname_code_scanning %}. For example, you might configure each server to copy the runner from a central, internal location. Alternatively, you could use the REST API to get the runner directly from {% data variables.product.prodname_dotcom %}, for example: ```shell -wget https://github.com/github/codeql-action/releases/latest/download/codeql-runner-linux +wget https://{% if currentVersion == "enterprise-server@2.22" or currentVersion == "free-pro-team@latest" %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action/releases/latest/download/codeql-runner-linux chmod +x codeql-runner-linux ``` In addition to this, each CI server also needs: -- A {% data variables.product.prodname_github_app %} or personal access token for the {% data variables.product.prodname_codeql_runner %} to use. You must use an access token with the `security_events` scope, or a {% data variables.product.prodname_github_app %} with the `security_events` write permission. For information, see "[Building {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps)" and "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." +- A {% data variables.product.prodname_github_app %} or personal access token for the {% data variables.product.prodname_codeql_runner %} to use. You must use an access token with the `repo` scope, or a {% data variables.product.prodname_github_app %} with the `security_events` write permission, and `metadata` and `contents` read permissions. For information, see "[Building {% data variables.product.prodname_github_apps %}](/developers/apps/building-github-apps)" and "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." - Access to the {% data variables.product.prodname_codeql %} bundle associated with this release of the {% data variables.product.prodname_codeql_runner %}. This package contains queries and libraries needed for {% data variables.product.prodname_codeql %} analysis, plus the {% data variables.product.prodname_codeql %} CLI, which is used internally by the runner. For information, see "[{% data variables.product.prodname_codeql %} CLI](https://codeql.github.com/docs/codeql-cli/)." The options for providing access to the {% data variables.product.prodname_codeql %} bundle are: -1. Allow the CI servers access to {% data variables.product.prodname_dotcom_the_website %} so that the {% data variables.product.prodname_codeql_runner %} can download the bundle automatically. -1. Manually download/extract the bundle, store it with other central resources, and use the `--codeql-path` flag to specify the location of the bundle in calls to initialize the {% data variables.product.prodname_codeql_runner %}. -{% if enterpriseServerVersions contains currentVersion %} -1. You can mirror the `github/codeql-action` repository on {% data variables.product.product_location %}. Unless you specify the `--codeql-path` flag, the runner automatically checks for the bundle in this location and on {% data variables.product.prodname_dotcom_the_website %}.{% endif %} +1. Allow the CI servers access to https://{% if currentVersion == "enterprise-server@2.22" or currentVersion == "free-pro-team@latest" %}github.com{% else %}HOSTNAME{% endif %}/github/codeql-action so that the {% data variables.product.prodname_codeql_runner %} can download the bundle automatically. +{% if currentVersion == "enterprise-server@2.22" %} +1. Mirror the `github/codeql-action` repository on {% data variables.product.product_name %}. Unless you specify the `--codeql-path` flag, the runner automatically checks for the bundle in this location and on {% data variables.product.prodname_dotcom_the_website %}.{% endif %} +1. Manually download/extract the bundle, store it with other central resources, and use the `--codeql-path` flag to specify the location of the bundle in calls to initialize the {% data variables.product.prodname_codeql_runner %}. ### Calling the {% data variables.product.prodname_codeql_runner %} You should call the {% data variables.product.prodname_codeql_runner %} from the checkout location of the repository you want to analyze. The two main commands are: 1. `init` required to initialize the runner and create a {% data variables.product.prodname_codeql %} database for each language to be analyzed. These databases are populated and analyzed by subsequent commands. -1. `analyze` required to populate the {% data variables.product.prodname_codeql %} databases, analyze them, and upload results to {% data variables.product.product_location %}. +1. `analyze` required to populate the {% data variables.product.prodname_codeql %} databases, analyze them, and upload results to {% data variables.product.product_name %}. -For both commands, you must specify the URL of {% data variables.product.product_location %}, the repository *OWNER/NAME*, and the GitHub Apps or personal access token to use for authentication. You also need to specify the location of the CodeQL bundle unless the CI server has access to download it directly from the `github/codeql-action` repository on {% data variables.product.prodname_dotcom_the_website %}{% if enterpriseServerVersions contains currentVersion %} or mirrored on {% data variables.product.product_location %}{% endif %}. +For both commands, you must specify the URL of {% data variables.product.product_name %}, the repository *OWNER/NAME*, and the {% data variables.product.prodname_github_apps %} or personal access token to use for authentication. You also need to specify the location of the CodeQL bundle, unless the CI server has access to download it directly from the `github/codeql-action` repository. You can configure where the {% data variables.product.prodname_codeql_runner %} stores the CodeQL bundle for future analysis on a server using the `--tools-dir` flag and where it stores temporary files during analysis using `--temp-dir`. @@ -121,7 +122,7 @@ This example runs {% data variables.product.prodname_codeql %} analysis on a Lin > Successfully uploaded results ``` -The server has access to download the {% data variables.product.prodname_codeql %} bundle directly from the `github/codeql-action` repository on {% data variables.product.prodname_dotcom_the_website %}{% if enterpriseServerVersions contains currentVersion %} or mirrored on {% data variables.product.product_location %}{% endif %}, so there is no need to use the `--codeql-path` flag. When the analysis is complete, the {% data variables.product.prodname_codeql_runner %} uploads the results to the {% data variables.product.prodname_code_scanning %} view. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository)." +The server has access to download the {% data variables.product.prodname_codeql %} bundle directly from the `github/codeql-action` repository, so there is no need to use the `--codeql-path` flag. When the analysis is complete, the {% data variables.product.prodname_codeql_runner %} uploads the results to the {% data variables.product.prodname_code_scanning %} view. For more information, see "[Managing {% data variables.product.prodname_code_scanning %} alerts for your repository](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository)." #### Compiled language example @@ -142,14 +143,15 @@ This example is similar to the previous example, however this time the repositor . /srv/checkout/example-repo-2/codeql-runner/codeql-env.sh". ``` -1. Run the script generated by the `init` action to set up the environment to monitor the build. +1. Source the script generated by the `init` action to set up the environment to monitor the build. Note the leading dot and space in the following code snippet. ```shell $ . /srv/checkout/example-repo-2/codeql-runner/codeql-env.sh ``` -1. Build the code. -1. Populate the {% data variables.product.prodname_codeql %} databases, analyze them, and upload the results to GitHub. +1. Build the code. On macOS, you need to prefix the build command with the environment variable `$CODEQL_RUNNER`. For more information, see "[Troubleshooting CodeQL code scanning in your CI system](/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system#no-code-found-during-the-build)." + +1. Populate the {% data variables.product.prodname_codeql %} databases, analyze them, and upload the results to {% data variables.product.prodname_dotcom %}. ```shell $ /path/to-runner/codeql-runner-linux analyze --repository octo-org/example-repo-2 diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning.md index 2d6783b8036e..eb3de3852583 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning.md @@ -8,6 +8,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.code-scanning.beta %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository.md index c23538ba91fe..e7659aeb0920 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/setting-up-code-scanning-for-a-repository.md @@ -11,6 +11,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.code-scanning.beta %} @@ -28,7 +29,7 @@ You decide how to generate {% data variables.product.prodname_code_scanning %} a {% data reusables.repositories.navigate-to-repo %} {% data reusables.repositories.sidebar-security %} -3. To the right of "{% data variables.product.prodname_code_scanning_capc %}", click **Set up {% data variables.product.prodname_code_scanning %}**. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}If {% data variables.product.prodname_code_scanning %} is missing, you need to ask an organization owner or repository administrator to enable {% data variables.product.prodname_GH_advanced_security %}. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" or "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} +3. To the right of "{% data variables.product.prodname_code_scanning_capc %} alerts", click **Set up {% data variables.product.prodname_code_scanning %}**. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}If {% data variables.product.prodname_code_scanning %} is missing, you need to ask an organization owner or repository administrator to enable {% data variables.product.prodname_GH_advanced_security %}. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" or "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)."{% endif %} !["Set up {% data variables.product.prodname_code_scanning %}" button to the right of "{% data variables.product.prodname_code_scanning_capc %}" in the Security Overview](/assets/images/help/security/overview-set-up-code-scanning.png) 4. Under "Get started with {% data variables.product.prodname_code_scanning %}", click **Set up this workflow** on the {% data variables.product.prodname_codeql_workflow %} or on a third-party workflow. !["Set up this workflow" button under "Get started with {% data variables.product.prodname_code_scanning %}" heading](/assets/images/help/repository/code-scanning-set-up-this-workflow.png) diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests.md index a0c75841b628..496acb280221 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests.md @@ -7,6 +7,7 @@ permissions: 'If you have read permission for a repository, you can see annotati versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.code-scanning.beta %} @@ -31,7 +32,7 @@ When you look at the **Files changed** tab for a pull request, you see annotatio ![Alert annotation within a pull request diff](/assets/images/help/repository/code-scanning-pr-annotation.png) -If you have write permission for the repository, some annotations contain links with extra context for the alert. In the example above, from {% data variables.product.prodname_codeql %} analysis, you can click **user-provided value** to see where the untrusted data enters the data flow (this is referred to as the source). In this case you can also view the full path from the source to the code that uses the data (the sink) by clicking **Show paths**. This makes it easy to check whether the data is untrusted or if the analysis failed to recognize a data sanitization step between the source and the sink. For information about analyzing data flow using {% data variables.product.prodname_codeql %}, see "[About data flow analysis](https://help.semmle.com/QL/learn-ql/intro-to-data-flow.html)." +If you have write permission for the repository, some annotations contain links with extra context for the alert. In the example above, from {% data variables.product.prodname_codeql %} analysis, you can click **user-provided value** to see where the untrusted data enters the data flow (this is referred to as the source). In this case you can also view the full path from the source to the code that uses the data (the sink) by clicking **Show paths**. This makes it easy to check whether the data is untrusted or if the analysis failed to recognize a data sanitization step between the source and the sink. For information about analyzing data flow using {% data variables.product.prodname_codeql %}, see "[About data flow analysis](https://codeql.github.com/docs/writing-codeql-queries/about-data-flow-analysis/)." To see more information about an alert, users with write permission can click the **Show more details** link shown in the annotation. This allows you to see all of the context and metadata provided by the tool in an alert view. In the example below, you can see tags showing the severity, type, and relevant common weakness enumerations (CWEs) for the problem. The view also shows which commit introduced the problem. diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system.md index e53bd81edc09..6a37da5f57d9 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-codeql-code-scanning-in-your-ci-system.md @@ -8,6 +8,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.code-scanning.beta-codeql-runner %} @@ -51,4 +52,7 @@ If the `analyze` command for the {% data variables.product.prodname_codeql_runne {% endnote %} +1. You're analyzing a compiled language on macOS without using the `autobuild` command and you run the build steps yourself after the `init` step. If SIP (System Integrity Protection) is enabled, which is the default on recent versions of OSX, analysis might fail. To fix this, prefix the build command with the `$CODEQL_RUNNER` environment variable. + For example, if your build command is `cmd arg1 arg2`, you should run `$CODEQL_RUNNER cmd arg1 arg2`. + 1. The code is built in a container or on a separate machine. If you use a containerized build or if you outsource the build to another machine, make sure to run the {% data variables.product.prodname_codeql_runner %} in the container or on the machine where your build task takes place. For more information, see "[Running CodeQL code scanning in a container](/github/finding-security-vulnerabilities-and-errors-in-your-code/running-codeql-code-scanning-in-a-container)." diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md index f1c4d3e53a37..5e1f031769f0 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/troubleshooting-the-codeql-workflow.md @@ -8,6 +8,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.code-scanning.beta %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md index b597086da286..a8908896f78c 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/uploading-a-sarif-file-to-github.md @@ -9,6 +9,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.code-scanning.beta %} diff --git a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/using-codeql-code-scanning-with-your-existing-ci-system.md b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/using-codeql-code-scanning-with-your-existing-ci-system.md index af71f4047d5b..942e66060bc4 100644 --- a/content/github/finding-security-vulnerabilities-and-errors-in-your-code/using-codeql-code-scanning-with-your-existing-ci-system.md +++ b/content/github/finding-security-vulnerabilities-and-errors-in-your-code/using-codeql-code-scanning-with-your-existing-ci-system.md @@ -7,5 +7,6 @@ product: '{% data reusables.gated-features.code-scanning %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- diff --git a/content/github/getting-started-with-github/about-github-advanced-security.md b/content/github/getting-started-with-github/about-github-advanced-security.md index 7f56cb9742ec..bd50369cfae7 100644 --- a/content/github/getting-started-with-github/about-github-advanced-security.md +++ b/content/github/getting-started-with-github/about-github-advanced-security.md @@ -4,6 +4,7 @@ intro: '{% data variables.product.prodname_dotcom %} makes extra security featur versions: free-pro-team: '*' enterprise-server: '>=3.0' + github-ae: '*' --- ### About {% data variables.product.prodname_GH_advanced_security %} @@ -36,16 +37,21 @@ For information about {% data variables.product.prodname_advanced_security %} fe {% endif %} -{% if currentVersion ver_gt "enterprise-server@2.22" %} -### Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.prodname_ghe_server %} +{% if currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} +### Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.product_name %} +{% if currentVersion ver_gt "enterprise-server@2.22" %} The site administrator must enable {% data variables.product.prodname_advanced_security %} for {% data variables.product.product_location %} before you can use these features. For more information, see "[Configuring Advanced Security features](/admin/configuration/configuring-advanced-security-features)." +{% endif %} Once your system is set up, you can enable and disable these features at the organization or repository level. For more information, see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)" and "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)." +{% if currentVersion ver_gt "enterprise-server@2.22" %} For information about purchasing a license for {% data variables.product.prodname_GH_advanced_security %}, contact {% data variables.contact.contact_enterprise_sales %}. {% endif %} +{% endif %} +{% if currentVersion != "github-ae@latest" %} ### Enabling {% data variables.product.prodname_advanced_security %} features on {% data variables.product.prodname_dotcom_the_website %} For public repositories on {% data variables.product.prodname_dotcom_the_website %}, these features are permanently on and are only disabled if you change the visibility of the project so that the code is no longer public. @@ -60,3 +66,4 @@ If you have an enterprise account, license use for the enterprise is shown on yo For information about purchasing a license for {% data variables.product.prodname_GH_advanced_security %}, contact {% data variables.contact.contact_enterprise_sales %}. {% endif %} +{% endif %} diff --git a/content/github/getting-started-with-github/keyboard-shortcuts.md b/content/github/getting-started-with-github/keyboard-shortcuts.md index 26090a8dae63..66c0cdd97c29 100644 --- a/content/github/getting-started-with-github/keyboard-shortcuts.md +++ b/content/github/getting-started-with-github/keyboard-shortcuts.md @@ -64,6 +64,7 @@ For more keyboard shortcuts, see the [CodeMirror documentation](https://codemirr |w | Switch to a new branch or tag |y | Expand a URL to its canonical form. For more information, see "[Getting permanent links to files](/articles/getting-permanent-links-to-files)." |i | Show or hide comments on diffs. For more information, see "[Commenting on the diff of a pull request](/articles/commenting-on-the-diff-of-a-pull-request)." +|a | Show or hide annotations on diffs |b | Open blame view. For more information, see "[Tracing changes in a file](/articles/tracing-changes-in-a-file)." ### Comments diff --git a/content/github/searching-for-information-on-github/about-searching-on-github.md b/content/github/searching-for-information-on-github/about-searching-on-github.md index aa30f601d76c..39c71d8a5b90 100644 --- a/content/github/searching-for-information-on-github/about-searching-on-github.md +++ b/content/github/searching-for-information-on-github/about-searching-on-github.md @@ -45,7 +45,7 @@ You can search for the following information across all repositories you can acc - [Discussions](/github/searching-for-information-on-github/searching-discussions){% endif %} - [Code](/articles/searching-code) - [Commits](/articles/searching-commits) -- [Users](/articles/searching-users){% if currentVersion == "free-pro-team@latest" %} +- [Users](/articles/searching-users){% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" or currentVersion ver_gt "enterprise-server@2.21" %} - [Packages](/github/searching-for-information-on-github/searching-for-packages){% endif %} - [Wikis](/articles/searching-wikis) diff --git a/content/github/searching-for-information-on-github/understanding-the-search-syntax.md b/content/github/searching-for-information-on-github/understanding-the-search-syntax.md index 917ed579ab7a..9f0908220511 100644 --- a/content/github/searching-for-information-on-github/understanding-the-search-syntax.md +++ b/content/github/searching-for-information-on-github/understanding-the-search-syntax.md @@ -48,7 +48,7 @@ Query | Example <=YYYY-MM-DD | **[cats created:<=2012-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A%3C%3D2012-07-04&type=Issues)** matches issues with the word "cats" that were created on or before July 4, 2012. YYYY-MM-DD..YYYY-MM-DD | **[cats pushed:2016-04-30..2016-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+pushed%3A2016-04-30..2016-07-04&type=Repositories)** matches repositories with the word "cats" that were pushed to between the end of April and July of 2016. YYYY-MM-DD..* | **[cats created:2012-04-30..*](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A2012-04-30..*&type=Issues)** matches issues created after April 30th, 2012 containing the word "cats." -*..YYYY-MM-DD | **[cats created:*..2012-04-30](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A*..2012-07-04&type=Issues)** matches issues created before July 4th, 2012 containing the word "cats." +*..YYYY-MM-DD | **[cats created:*..2012-07-04](https://github.com/search?utf8=%E2%9C%93&q=cats+created%3A*..2012-07-04&type=Issues)** matches issues created before July 4th, 2012 containing the word "cats." {% data reusables.time_date.time_format %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization.md index 5934c0738154..4ff72e431c0b 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-organization.md @@ -4,6 +4,7 @@ intro: 'You can configure the retention period for {% data variables.product.pro versions: free-pro-team: '*' enterprise-server: '>=2.23' + github-ae: '*' --- {% data reusables.actions.about-artifact-log-retention %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization.md index 5dc65ade412d..be683104337d 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/disabling-or-limiting-github-actions-for-your-organization.md @@ -4,6 +4,7 @@ intro: 'Organization owners can disable, enable, and limit GitHub Actions for an versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.actions.enterprise-beta %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization.md index d92c67df7d84..197bdfc5bea4 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-allowed-ip-addresses-for-your-organization.md @@ -4,10 +4,11 @@ intro: You can restrict access to your organization's assets by configuring a li product: '{% data reusables.gated-features.allowed-ip-addresses %}' versions: free-pro-team: '*' + github-ae: '*' --- Organization owners can manage allowed IP addresses for an organization. - + ### About allowed IP addresses You can restrict access to organization assets by configuring an allow list for specific IP addresses. {% data reusables.identity-and-permissions.ip-allow-lists-example-and-restrictions %} @@ -16,7 +17,7 @@ You can restrict access to organization assets by configuring an allow list for {% data reusables.identity-and-permissions.ip-allow-lists-enable %} -You can also configure allowed IP addresses for the organizations in an enterprise account. For more information, see "[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account#managing-allowed-ip-addresses-for-organizations-in-your-enterprise-account)." +You can also configure allowed IP addresses for the organizations in an enterprise account. For more information, see {% if currentVersion == "github-ae@latest" %}"[Restricting network traffic to your enterprise](/admin/configuration/restricting-network-traffic-to-your-enterprise)." {% else %}"[Enforcing security settings in your enterprise account](/github/setting-up-and-managing-your-enterprise/enforcing-security-settings-in-your-enterprise-account#managing-allowed-ip-addresses-for-organizations-in-your-enterprise-account)."{% endif %} ### Adding an allowed IP address @@ -60,4 +61,12 @@ You can also configure allowed IP addresses for the organizations in an enterpri ### Using {% data variables.product.prodname_actions %} with an IP allow list +{% if currentVersion == "github-ae@latest" %} + +{% data reusables.github-actions.ip-allow-list-hosted-runners %} + +{% else %} + {% data reusables.github-actions.ip-allow-list-self-hosted-runners %} + +{% endif %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization.md index 2bc198a304d8..4c91d7d56748 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization.md @@ -7,6 +7,7 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=3.0' + github-ae: '*' --- ### About management of security and analysis settings @@ -29,6 +30,8 @@ The page that's displayed allows you to enable or disable all security and analy {% if currentVersion ver_gt "enterprise-server@3.0" %}If you have a license for {% data variables.product.prodname_GH_advanced_security %}, the page will also contain options to enable and disable {% data variables.product.prodname_advanced_security %} features. Any repositories that use {% data variables.product.prodname_GH_advanced_security %} are listed at the bottom of the page.{% endif %} +{% if currentVersion == "github-ae@latest" %}The page will also contain options to enable and disable {% data variables.product.prodname_advanced_security %} features.{% endif %} + ### Enabling or disabling a feature for all existing repositories You can enable or disable features for all repositories. {% if currentVersion == "free-pro-team@latest" %}The impact of your changes on repositories in your organization is determined by their visibility: @@ -39,37 +42,53 @@ You can enable or disable features for all repositories. {% if currentVersion == - **{% data variables.product.prodname_GH_advanced_security %}** - Your changes affect only private repositories because {% data variables.product.prodname_GH_advanced_security %} and the related features are always enabled for public repositories. - **{% data variables.product.prodname_secret_scanning_caps %}** - Your changes affect only private repositories where {% data variables.product.prodname_GH_advanced_security %} is also enabled. {% data variables.product.prodname_secret_scanning_caps %} is always enabled for public repositories.{% endif %} -{% data reusables.advanced-security.note-org-enable-uses-seats %} +{% data reusables.advanced-security.note-org-enable-uses-seats %} 1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)." -1. Under "Configure security and analysis features", to the right of the feature, click **Disable all** or **Enable all**. +2. Under "Configure security and analysis features", to the right of the feature, click **Disable all** or **Enable all**. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} !["Enable all" or "Disable all" button for "Configure security and analysis" features](/assets/images/help/organizations/security-and-analysis-disable-or-enable-all-ghas-dotcom.png) - {% else if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} + {% endif %} + {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} !["Enable all" or "Disable all" button for "Configure security and analysis" features](/assets/images/help/organizations/security-and-analysis-disable-or-enable-all-ghe.png) {% endif %} -2. Optionally, enable the feature by default for new repositories in your organization. + {% if currentVersion == "github-ae@latest" %} + !["Enable all" or "Disable all" button for "Configure security and analysis" features](/assets/images/enterprise/github-ae/organizations/security-and-analysis-disable-or-enable-all-ghae.png) + {% endif %} + {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +3. Optionally, enable the feature by default for new repositories in your organization. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} !["Enable by default" option for new repositories](/assets/images/help/organizations/security-and-analysis-enable-by-default-in-modal.png) - {% else if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} + {% endif %} + {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} !["Enable by default" option for new repositories](/assets/images/help/organizations/security-and-analysis-secret-scanning-enable-by-default-ghe.png) {% endif %} -3. Click **Disable FEATURE** or **Enable FEATURE** to disable or enable the feature for all the repositories in your organization. +4. Click **Disable FEATURE** or **Enable FEATURE** to disable or enable the feature for all the repositories in your organization. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} ![Button to disable or enable feature](/assets/images/help/organizations/security-and-analysis-enable-dependency-graph.png) - {% else if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} + {% endif %} + {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} ![Button to disable or enable feature](/assets/images/help/organizations/security-and-analysis-enable-secret-scanning-ghe.png) {% endif %} + {% endif %} + {% if currentVersion == "github-ae@latest" %} +3. Click **Enable for all eligible repositories** to enable the feature for all the new repositories in your organization that will have {% data variables.product.prodname_advanced_security %} enabled. + ![Button to enable feature for all the eligible repositories in the organization](/assets/images/enterprise/github-ae/organizations/security-and-analysis-enable-secret-scanning-existing-repos-ghae.png) + {% endif %} ### Enabling or disabling a feature automatically when new repositories are added 1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)." -1. Under "Configure security and analysis features", to the right of the feature, enable or disable the feature by default for new repositories{% if currentVersion == "free-pro-team@latest" %}, or all new private repositories,{% endif %} in your organization. +2. Under "Configure security and analysis features", to the right of the feature, enable or disable the feature by default for new repositories{% if currentVersion == "free-pro-team@latest" %}, or all new private repositories,{% endif %} in your organization. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} ![Checkbox for enabling or disabling a feature for new repositories](/assets/images/help/organizations/security-and-analysis-enable-or-disable-feature-checkbox-dotcom.png) - {% else if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} + {% endif %} + {% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.22" %} ![Checkbox for enabling or disabling a feature for new repositories](/assets/images/help/organizations/security-and-analysis-enable-or-disable-secret-scanning-checkbox-ghe.png) {% endif %} + {% if currentVersion == "github-ae@latest" %} + ![Checkbox for enabling or disabling a feature for new repositories](/assets/images/enterprise/github-ae/organizations/security-and-analysis-enable-or-disable-secret-scanning-checkbox-ghae.png) + {% endif %} {% data reusables.advanced-security.note-org-enable-uses-seats %} @@ -84,12 +103,14 @@ You can enable or disable features for all repositories. {% if currentVersion == By default, {% data variables.product.prodname_dependabot %} can't update dependencies that are located in private repositories. However, if a dependency is in a private {% data variables.product.prodname_dotcom %} repository within the same organization as the project that uses that dependency, you can allow {% data variables.product.prodname_dependabot %} to update the version successfully by giving it access to the host repository. For more information, including details of limitations to private dependency support, see "[About Dependabot version updates](/github/administering-a-repository/about-dependabot-version-updates)." 1. Go to the security and analysis settings for your organization. For more information, see "[Displaying the security and analysis settings](#displaying-the-security-and-analysis-settings)." -1. In the "{% data variables.product.prodname_dependabot %} repository access" section, click the settings button **{% octicon "gear" aria-label="The Gear icon" %}**. - ![Repository access setting button](/assets/images/help/organizations/repository-access-cog-button.png) - A list is displayed showing all of the private repositories in your organization. - ![The Repositories list](/assets/images/help/organizations/repositories-dialog.png) -1. Select the repositories that {% data variables.product.prodname_dependabot %} can access. -1. Click **Select repositories**. +1. Under "{% data variables.product.prodname_dependabot %} private repository access", click **Add private repositories** or **Add internal and private repositories**. + ![Add repositories button](/assets/images/help/organizations/dependabot-private-repository-access.png) +1. Start typing the name of the repository you want to allow. + ![Add repositories button](/assets/images/help/organizations/dependabot-private-repo-choose.png) +1. Click the repository you want to allow. + +1. Optionally, to remove a repository from the list, to the right of the repository, click {% octicon "x" aria-label="The X icon" %}. + !["X" button to remove a repository](/assets/images/help/organizations/dependabot-private-repository-list.png) {% endif %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} @@ -117,6 +138,6 @@ You can manage the use of {% data variables.product.prodname_GH_advanced_securit - "[About securing your repository](/github/administering-a-repository/about-securing-your-repository)" - "[About secret scanning](/github/administering-a-repository/about-secret-scanning)"{% if currentVersion == "free-pro-team@latest" %} -- "[Keeping your dependencies updated automatically](/github/administering-a-repository/keeping-your-dependencies-updated-automatically)"{% endif %} +- "[Keeping your dependencies updated automatically](/github/administering-a-repository/keeping-your-dependencies-updated-automatically)"{% endif %}{% if currentVersion != "github-ae@latest" %} - "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)" -- "[Managing vulnerabilities in your project's dependencies](/github/managing-security-vulnerabilities/managing-vulnerabilities-in-your-projects-dependencies)" +- "[Managing vulnerabilities in your project's dependencies](/github/managing-security-vulnerabilities/managing-vulnerabilities-in-your-projects-dependencies)"{% endif %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization.md index e1a0fc2666a5..184d6d2537f0 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/managing-the-publication-of-github-pages-sites-for-your-organization.md @@ -6,9 +6,10 @@ product: '{% data reusables.gated-features.pages %}' versions: free-pro-team: '*' enterprise-server: '>=3.0' + github-ae: '*' redirect_from: - /github/setting-up-and-managing-organizations-and-teams/disabling-publication-of-github-pages-sites-for-your-organization - + --- {% if currentVersion == "free-pro-team@latest" %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization.md index 0b69ba892675..54c5d401fb6d 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/permission-levels-for-an-organization.md @@ -116,6 +116,7 @@ Organization members can have *owner*{% if currentVersion == "free-pro-team@late | [View people with access to an organization repository](/articles/viewing-people-with-access-to-your-repository) | **X** | | | [Export a list of people with access to an organization repository](/articles/viewing-people-with-access-to-your-repository/#exporting-a-list-of-people-with-access-to-your-repository) | **X** | |{% if currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %} | Manage default labels (see "[Managing default labels for repositories in your organization](/articles/managing-default-labels-for-repositories-in-your-organization)") | **X** | |{% endif %} +{% if currentVersion == "github-ae@latest" %}| Manage IP allow lists (see "[Restricting network traffic to your enterprise](/admin/configuration/restricting-network-traffic-to-your-enterprise)") | **X** | |{% endif %} {% endif %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md index a4c6c09b1370..8a15a1ef63ec 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization.md @@ -87,10 +87,10 @@ In addition to managing organization-level settings, organization owners have ad | Create, edit, run, re-run, and cancel [GitHub Actions workflows](/actions/automating-your-workflow-with-github-actions/) | | | **X** | **X** | **X** |{% endif %} | Create and edit releases | | | **X** | **X** | **X** | | View draft releases | | | **X** | **X** | **X** | -| Edit a repository's description | | | | **X** | **X** |{% if currentVersion == "free-pro-team@latest" %} +| Edit a repository's description | | | | **X** | **X** |{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" %} | [View and install packages](/packages/publishing-and-managing-packages) | **X** | **X** | **X** | **X** | **X** | | [Publish packages](/packages/publishing-and-managing-packages/publishing-a-package) | | | **X** | **X** | **X** | -| [Delete packages](/packages/learn-github-packages/deleting-and-restoring-a-package) | | | | | **X** | {% endif %} +| {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Delete and restore packages](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Delete packages](/packages/learn-github-packages/deleting-a-package){% endif %} | | | | | **X** | {% endif %} | Manage [topics](/articles/classifying-your-repository-with-topics) | | | | **X** | **X** | | Enable wikis and restrict wiki editors | | | | **X** | **X** | | Enable project boards | | | | **X** | **X** | @@ -130,22 +130,22 @@ In addition to managing organization-level settings, organization owners have ad | [Create new discussions and comment on existing discussions](/discussions/collaborating-with-your-community-using-discussions/participating-in-a-discussion) | **X** | **X** | **X** | **X** | **X** | | [Delete a discussion](/discussions/managing-discussions-for-your-community/managing-discussions-in-your-repository#deleting-a-discussion) | | | | **X** | **X** |{% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} #### Permission requirements for security features -In this section, you can find the repository permission levels required for security features, such as {% data variables.product.prodname_dependabot %} and {% data variables.product.prodname_advanced_security %} features. +In this section, you can find the repository permission levels required for security features, such as {% data variables.product.prodname_advanced_security %} features. | Repository action | Read | Triage | Write | Maintain | Admin | |:---|:---:|:---:|:---:|:---:|:---:|{% if currentVersion == "free-pro-team@latest" %} | Receive [{% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies) in a repository | | | | | **X** | | [Dismiss {% data variables.product.prodname_dependabot_alerts %}](/github/managing-security-vulnerabilities/viewing-and-updating-vulnerable-dependencies-in-your-repository) | | | | | **X** | | [Designate additional people or teams to receive {% data variables.product.prodname_dependabot_alerts %}](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts) for vulnerable dependencies | | | | | **X** | -| Create [security advisories](/github/managing-security-vulnerabilities/about-github-security-advisories) | | | | | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +| Create [security advisories](/github/managing-security-vulnerabilities/about-github-security-advisories) | | | | | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} | Manage access to {% data variables.product.prodname_GH_advanced_security %} features (see "[Managing security and analysis settings for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-security-and-analysis-settings-for-your-organization)") | | | | | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" %} | [Enable the dependency graph](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-and-dependents-of-a-repository) for a private repository | | | | | **X** | -| [View dependency reviews](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request) | **X** | **X** | **X** | **X** | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +| [View dependency reviews](/github/collaborating-with-issues-and-pull-requests/reviewing-dependency-changes-in-a-pull-request) | **X** | **X** | **X** | **X** | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} | [View {% data variables.product.prodname_code_scanning %} alerts on pull requests](/github/finding-security-vulnerabilities-and-errors-in-your-code/triaging-code-scanning-alerts-in-pull-requests) | **X** | **X** | **X** | **X** | **X** | -| [List, dismiss, and delete {% data variables.product.prodname_code_scanning %} alerts](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository) | | | **X** | **X** | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +| [List, dismiss, and delete {% data variables.product.prodname_code_scanning %} alerts](/github/finding-security-vulnerabilities-and-errors-in-your-code/managing-code-scanning-alerts-for-your-repository) | | | **X** | **X** | **X** |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} | [View {% data variables.product.prodname_secret_scanning %} alerts in a repository](/github/administering-a-repository/managing-alerts-from-secret-scanning) | | | | | **X** | | [Resolve, revoke or re-open {% data variables.product.prodname_secret_scanning %} alerts](/github/administering-a-repository/managing-alerts-from-secret-scanning) | | | | | **X** | | [Designate additional people or teams to receive {% data variables.product.prodname_secret_scanning %} alerts](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository#granting-access-to-security-alerts) in repositories | | | | | **X** |{% endif %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md b/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md index 4cc6da0fc59e..d8e83edc9d38 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/reviewing-the-audit-log-for-your-organization.md @@ -58,10 +58,10 @@ To search for specific events, use the `action` qualifier in your query. Actions | [`repo`](#repo-category-actions) | Contains activities related to the repositories owned by your organization.{% if currentVersion == "free-pro-team@latest" %} | [`repository_advisory`](#repository_advisory-category-actions) | Contains repository-level activities related to security advisories in the {% data variables.product.prodname_advisory_database %}. For more information, see "[About {% data variables.product.prodname_dotcom %} Security Advisories](/github/managing-security-vulnerabilities/about-github-security-advisories)." | [`repository_content_analysis`](#repository_content_analysis-category-actions) | Contains all activities related to [enabling or disabling data use for a private repository](/articles/about-github-s-use-of-your-data).{% endif %}{% if currentVersion != "github-ae@latest" %} -| [`repository_dependency_graph`](#repository_dependency_graph-category-actions) | Contains repository-level activities related to enabling or disabling the dependency graph for a {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +| [`repository_dependency_graph`](#repository_dependency_graph-category-actions) | Contains repository-level activities related to enabling or disabling the dependency graph for a {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)."{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} | [`repository_secret_scanning`](#repository_secret_scanning-category-actions) | Contains repository-level activities related to secret scanning. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." {% endif %}{% if currentVersion != "github-ae@latest" %} | [`repository_vulnerability_alert`](#repository_vulnerability_alert-category-actions) | Contains all activities related to [{% data variables.product.prodname_dependabot_alerts %} for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies).{% endif %}{% if currentVersion == "free-pro-team@latest" %} -| [`repository_vulnerability_alerts`](#repository_vulnerability_alerts-category-actions) | Contains repository-level configuration activities for {% data variables.product.prodname_dependabot %} alerts. {% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +| [`repository_vulnerability_alerts`](#repository_vulnerability_alerts-category-actions) | Contains repository-level configuration activities for {% data variables.product.prodname_dependabot %} alerts. {% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} | [`secret_scanning`](#secret_scanning-category-actions) | Contains organization-level configuration activities for secret scanning in existing repositories. For more information, see "[About secret scanning](/github/administering-a-repository/about-secret-scanning)." | [`secret_scanning_new_repos`](#secret_scanning_new_repos-category-actions) | Contains organization-level configuration activities for secret scanning for new repositories created in the organization. {% endif %}{% if currentVersion == "free-pro-team@latest" %} | [`sponsors`](#sponsors-category-actions) | Contains all events related to sponsor buttons (see "[Displaying a sponsor button in your repository](/articles/displaying-a-sponsor-button-in-your-repository)"){% endif %} @@ -530,7 +530,7 @@ For more information, see "[Managing the publication of {% data variables.produc | `disable` | Triggered when a repository owner or person with admin access to the repository disables the dependency graph for a {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repository. For more information, see "[About the dependency graph](/github/visualizing-repository-data-with-graphs/about-the-dependency-graph)." | `enable` | Triggered when a repository owner or person with admin access to the repository enables the dependency graph for a {% if currentVersion == "free-pro-team@latest" %}private {% endif %}repository. -{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} #### `repository_secret_scanning` category actions | Action | Description @@ -556,7 +556,7 @@ For more information, see "[Managing the publication of {% data variables.produc | `disable` | Triggered when a repository owner or person with admin access to the repository disables {% data variables.product.prodname_dependabot_alerts %}. | `enable` | Triggered when a repository owner or person with admin access to the repository enables {% data variables.product.prodname_dependabot_alerts %}. -{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} #### `secret_scanning` category actions | Action | Description @@ -616,7 +616,7 @@ For more information, see "[Managing the publication of {% data variables.produc | `disable` | Triggered when an organization owner disables team discussions for an organization. For more information, see "[Disabling team discussions for your organization](/articles/disabling-team-discussions-for-your-organization)." | `enable` | Triggered when an organization owner enables team discussions for an organization. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest"%} #### `workflows` category actions {% data reusables.actions.actions-audit-events-workflow %} diff --git a/content/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group.md b/content/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group.md index 7e9dd3bf05ea..8ff307982809 100644 --- a/content/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group.md +++ b/content/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group.md @@ -1,10 +1,11 @@ --- title: Synchronizing a team with an identity provider group -intro: 'You can synchronize a {% data variables.product.prodname_dotcom %} team with an identity provider (IdP) group to automatically add and remove team members.' +intro: 'You can synchronize a {% data variables.product.product_name %} team with an identity provider (IdP) group to automatically add and remove team members.' product: '{% data reusables.gated-features.team-synchronization %}' permissions: 'Organization owners and team maintainers can synchronize a {% data variables.product.prodname_dotcom %} team with an IdP group.' versions: free-pro-team: '*' + github-ae: '*' --- {% data reusables.gated-features.okta-team-sync %} @@ -13,29 +14,36 @@ versions: {% data reusables.identity-and-permissions.about-team-sync %} -You can connect up to five IdP groups to a {% data variables.product.prodname_dotcom %} team. An IdP group can be assigned to multiple {% data variables.product.prodname_dotcom %} teams without restriction. +{% if currentVersion == "free-pro-team@latest" %}You can connect up to five IdP groups to a {% data variables.product.product_name %} team.{% elsif currentVersion == "github-ae@latest" %}You can connect a team on {% data variables.product.product_name %} to one IdP group. All users in the group are automatically added to the team and also added to the parent organization as members. When you disconnect a group from a team, users who became members of the organization via team membership are removed from the organization.{% endif %} You can assign an IdP group to multiple {% data variables.product.product_name %} teams. -Team synchronization does not support IdP groups with more than 5000 members. +{% if currentVersion == "free-pro-team@latest" %}Team synchronization does not support IdP groups with more than 5000 members.{% endif %} -Once a {% data variables.product.prodname_dotcom %} team is connected to an IdP group, your IdP administrator must make team membership changes through the identity provider. You cannot manage team membership on {% data variables.product.product_name %} or using the API. +Once a {% data variables.product.prodname_dotcom %} team is connected to an IdP group, your IdP administrator must make team membership changes through the identity provider. You cannot manage team membership on {% data variables.product.product_name %}{% if currentVersion == "free-pro-team@latest" %}or using the API{% endif %}. +{% if currentVersion == "free-pro-team@latest" %} All team membership changes made through your IdP will appear in the audit log on {% data variables.product.product_name %} as changes made by the team synchronization bot. Your IdP will send team membership data to {% data variables.product.prodname_dotcom %} once every hour. Connecting a team to an IdP group may remove some team members. For more information, see "[Requirements for members of synchronized teams](#requirements-for-members-of-synchronized-teams)." +{% endif %} + +{% if currentVersion == "github-ae@latest" %} +When group membership changes on your IdP, your IdP sends a SCIM request with the changes to {% data variables.product.product_name %} according to the schedule determined by your IdP. Any requests that change {% data variables.product.prodname_dotcom %} team or organization membership will register in the audit log as changes made by the account used to configure user provisioning. For more information about this account, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise)." For more information about SCIM request schedules, see "[Check the status of user provisioning](https://docs.microsoft.com/en-us/azure/active-directory/app-provisioning/application-provisioning-when-will-provisioning-finish-specific-user)" in the Microsoft Docs. +{% endif %} Parent teams cannot synchronize with IdP groups. If the team you want to connect to an IdP group is a parent team, we recommend creating a new team or removing the nested relationships that make your team a parent team. For more information, see "[About teams](/articles/about-teams#nested-teams)," "[Creating a team](/github/setting-up-and-managing-organizations-and-teams/creating-a-team)," and "[Moving a team in your organization's hierarchy](/articles/moving-a-team-in-your-organizations-hierarchy)." To manage repository access for any {% data variables.product.prodname_dotcom %} team, including teams connected to an IdP group, you must make changes with {% data variables.product.product_name %}. For more information, see "[About teams](/articles/about-teams)" and "[Managing team access to an organization repository](/articles/managing-team-access-to-an-organization-repository)." -You can also manage team synchronization with the API. For more information, see "[Team synchronization](/rest/reference/teams#team-sync)." +{% if currentVersion == "free-pro-team@latest" %}You can also manage team synchronization with the API. For more information, see "[Team synchronization](/rest/reference/teams#team-sync)."{% endif %} +{% if currentVersion == "free-pro-team@latest" %} ### Requirements for members of synchronized teams -After you connect a team to an IdP group, team synchronization will add each member of the IdP group to the corresponding team on {% data variables.product.prodname_dotcom %} only if: -- The person is a member of the organization on {% data variables.product.prodname_dotcom %}. -- The person has already logged in with their user account on {% data variables.product.prodname_dotcom %} and authenticated to the organization or enterprise account via SAML single sign-on at least once. +After you connect a team to an IdP group, team synchronization will add each member of the IdP group to the corresponding team on {% data variables.product.product_name %} only if: +- The person is a member of the organization on {% data variables.product.product_name %}. +- The person has already logged in with their user account on {% data variables.product.product_name %} and authenticated to the organization or enterprise account via SAML single sign-on at least once. - The person's SSO identity is a member of the IdP group. -Existing teams or group members who do not meet these criteria will be automatically removed from the team on {% data variables.product.prodname_dotcom %} and lose access to repositories. Revoking a user's linked identity will also remove the user from from any teams mapped to IdP groups. For more information, see "[Viewing and managing a member's SAML access to your organization](/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)" and "[Viewing and managing a user's SAML access to your enterprise](/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise#viewing-and-revoking-a-linked-identity)." +Existing teams or group members who do not meet these criteria will be automatically removed from the team on {% data variables.product.product_name %} and lose access to repositories. Revoking a user's linked identity will also remove the user from from any teams mapped to IdP groups. For more information, see "[Viewing and managing a member's SAML access to your organization](/github/setting-up-and-managing-organizations-and-teams/viewing-and-managing-a-members-saml-access-to-your-organization#viewing-and-revoking-a-linked-identity)" and "[Viewing and managing a user's SAML access to your enterprise](/github/setting-up-and-managing-your-enterprise/viewing-and-managing-a-users-saml-access-to-your-enterprise#viewing-and-revoking-a-linked-identity)." A removed team member can be added back to a team automatically once they have authenticated to the organization or enterprise account using SSO and are moved to the connected IdP group. @@ -43,32 +51,49 @@ To avoid unintentionally removing team members, we recommend enforcing SAML SSO If your organization is owned by an enterprise account, enabling team synchronization for the enterprise account will override your organization-level team synchronization settings. For more information, see "[Managing team synchronization for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise-account)." +{% endif %} + ### Prerequisites -Before you can connect a team with an identity provider group, an organization or enterprise owner must enable team synchronization for your organization or enterprise account. For more information, see "[Managing team synchronization for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization)" and "[Managing team synchronization for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise-account)." +{% if currentVersion == "free-pro-team@latest" %} +Before you can connect a {% data variables.product.product_name %} team with an identity provider group, an organization or enterprise owner must enable team synchronization for your organization or enterprise account. For more information, see "[Managing team synchronization for your organization](/github/setting-up-and-managing-organizations-and-teams/managing-team-synchronization-for-your-organization)" and "[Managing team synchronization for organizations in your enterprise account](/github/setting-up-and-managing-your-enterprise/managing-team-synchronization-for-organizations-in-your-enterprise-account)." To avoid unintentionally removing team members, visit the administrative portal for your IdP and confirm that each current team member is also in the IdP groups that you want to connect to this team. If you don't have this access to your identity provider, you can reach out to your IdP administrator. You must authenticate using SAML SSO. For more information, see "[Authenticating with SAML single sign-on](/articles/authenticating-with-saml-single-sign-on)." +{% elsif currentVersion == "github-ae@latest" %} +Before you can connect a {% data variables.product.product_name %} team with an IdP group, you must first configure user provisioning for {% data variables.product.product_location %} using a supported System for Cross-domain Identity Management (SCIM). For more information, see "[Configuring user provisioning for your enterprise](/admin/authentication/configuring-user-provisioning-for-your-enterprise)." + +Once user provisioning for {% data variables.product.product_name %} is configured using SCIM, you can assign the {% data variables.product.product_name %} application to every IdP group that you want to use on {% data variables.product.product_name %}. For more information, see [Configure automatic user provisioning to GitHub AE](https://docs.microsoft.com/en-us/azure/active-directory/saas-apps/github-ae-provisioning-tutorial#step-5-configure-automatic-user-provisioning-to-github-ae) in the Microsoft Docs. +{% endif %} + ### Connecting an IdP group to a team +When you connect an IdP group to a {% data variables.product.product_name %} team, all users in the group are automatically added to the team. {% if currentVersion == "github-ae@latest" %}Any users who were not already members of the parent organization members are also added to the organization.{% endif %} + {% data reusables.profile.access_profile %} {% data reusables.profile.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} -5. Under "Identity Provider Groups", use the drop-down menu, and select up to 5 identity provider groups. - ![Drop-down menu to choose identity provider groups](/assets/images/help/teams/choose-an-idp-group.png) -6. Click **Save changes**. +{% if currentVersion == "free-pro-team@latest" %} +6. Under "Identity Provider Groups", use the drop-down menu, and select up to 5 identity provider groups. + ![Drop-down menu to choose identity provider groups](/assets/images/help/teams/choose-an-idp-group.png){% elsif currentVersion == "github-ae@latest" %} +6. Under "Identity Provider Group", use the drop-down menu, and select an identity provider group from the list. + ![Drop-down menu to choose identity provider group](/assets/images/enterprise/github-ae/teams/choose-an-idp-group.png){% endif %} +7. Click **Save changes**. ### Disconnecting an IdP group from a team -If you disconnect an IdP group from a {% data variables.product.prodname_dotcom %} team, team members that were assigned to the {% data variables.product.prodname_dotcom %} team through the IdP group will be removed from the team. +If you disconnect an IdP group from a {% data variables.product.prodname_dotcom %} team, team members that were assigned to the {% data variables.product.prodname_dotcom %} team through the IdP group will be removed from the team. {% if currentVersion == "github-ae@latest" %} Any users who were members of the parent organization only because of that team connection are also removed from the organization.{% endif %} {% data reusables.profile.access_profile %} {% data reusables.profile.access_org %} {% data reusables.organizations.specific_team %} {% data reusables.organizations.team_settings %} +{% if currentVersion == "free-pro-team@latest" %} 6. Under "Identity Provider Groups", to the right of the IdP group you want to disconnect, click {% octicon "x" aria-label="X symbol" %}. - ![Unselect a connected IdP group from the GitHub team](/assets/images/help/teams/unselect-idp-group.png) + ![Unselect a connected IdP group from the GitHub team](/assets/images/help/teams/unselect-idp-group.png){% elsif currentVersion == "github-ae@latest" %} +6. Under "Identity Provider Group", to the right of the IdP group you want to disconnect, click {% octicon "x" aria-label="X symbol" %}. + ![Unselect a connected IdP group from the GitHub team](/assets/images/enterprise/github-ae/teams/unselect-idp-group.png){% endif %} 7. Click **Save changes**. diff --git a/content/github/setting-up-and-managing-your-enterprise/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-enterprise-account.md b/content/github/setting-up-and-managing-your-enterprise/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-enterprise-account.md index 2bd1d3b7665f..5284cd63a311 100644 --- a/content/github/setting-up-and-managing-your-enterprise/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-enterprise-account.md +++ b/content/github/setting-up-and-managing-your-enterprise/configuring-the-retention-period-for-github-actions-artifacts-and-logs-in-your-enterprise-account.md @@ -8,6 +8,7 @@ miniTocMaxHeadingLevel: 4 versions: free-pro-team: '*' enterprise-server: '>=2.23' + github-ae: '*' --- {% data reusables.actions.about-artifact-log-retention %} diff --git a/content/github/setting-up-and-managing-your-enterprise/viewing-people-in-your-enterprise.md b/content/github/setting-up-and-managing-your-enterprise/viewing-people-in-your-enterprise.md index ba548c7c1de7..3b1bdfe5b3c4 100644 --- a/content/github/setting-up-and-managing-your-enterprise/viewing-people-in-your-enterprise.md +++ b/content/github/setting-up-and-managing-your-enterprise/viewing-people-in-your-enterprise.md @@ -23,7 +23,7 @@ You can view enterprise owners {% if currentVersion == "free-pro-team@latest" %} ### Viewing members and outside collaborators -You can view the number of pending members and outside collaborators. You can filter the list of members by {% if currentVersion == "free-pro-team@latest" %}deployment ({% data variables.product.prodname_ghe_cloud %} or {% data variables.product.prodname_ghe_server %}),{% endif %}role {% if currentVersion == "free-pro-team@latest" %}, and{% elsif currentVersion == "github-ae@latest" %}or {% endif %}organization. You can filter the list of outside collaborators by the visibility of the repositories the collaborator has access to. You can find a specific person by searching for their username or display name. +You can view the number of pending members and outside collaborators. You can filter the list of members by {% if currentVersion == "free-pro-team@latest" %}deployment ({% data variables.product.prodname_ghe_cloud %} or {% data variables.product.prodname_ghe_server %}),{% endif %} role{% if currentVersion == "free-pro-team@latest" %}, and{% else %} or {% endif %} organization. You can filter the list of outside collaborators by the visibility of the repositories the collaborator has access to. You can find a specific person by searching for their username or display name. You can view {% if currentVersion == "free-pro-team@latest" %}all the {% data variables.product.prodname_ghe_cloud %} organizations and {% data variables.product.prodname_ghe_server %} instances that a member belongs to, and {% endif %}which repositories an outside collaborator has access to{% if currentVersion == "free-pro-team@latest" %}, {% endif %} by clicking on the person's name. diff --git a/content/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository.md b/content/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository.md index 04f6dd83c5a7..94aee824d875 100644 --- a/content/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository.md +++ b/content/github/setting-up-and-managing-your-github-user-account/permission-levels-for-a-user-account-repository.md @@ -35,8 +35,9 @@ The repository owner has full control of the repository. In addition to the acti | Delete the repository | "[Deleting a repository](/github/administering-a-repository/deleting-a-repository)" | | Manage the repository's topics | "[Classifying your repository with topics](/github/administering-a-repository/classifying-your-repository-with-topics)" |{% if currentVersion == "free-pro-team@latest" %} | Manage security and analysis settings for the repository | "[Managing security and analysis settings for your repository](/github/administering-a-repository/managing-security-and-analysis-settings-for-your-repository)" |{% endif %}{% if currentVersion == "free-pro-team@latest" %} -| Enable the dependency graph for a private repository | "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)" |{% endif %}{% if currentVersion == "free-pro-team@latest" %} -| Delete packages | "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" |{% endif %} +| Enable the dependency graph for a private repository | "[Exploring the dependencies of a repository](/github/visualizing-repository-data-with-graphs/exploring-the-dependencies-of-a-repository#enabling-and-disabling-the-dependency-graph-for-a-private-repository)" |{% endif %}{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +| Delete and restore packages | "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)" |{% endif %}{% if currentVersion == "enterprise-server@2.22" or currentVersion == "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} +| Delete packages | "[Deleting packages](/packages/learn-github-packages/deleting-a-package)" |{% endif %} | Customize the repository's social media preview | "[Customizing your repository's social media preview](/github/administering-a-repository/customizing-your-repositorys-social-media-preview)" | | Create a template from the repository | "[Creating a template repository](/github/creating-cloning-and-archiving-repositories/creating-a-template-repository)" |{% if currentVersion == "free-pro-team@latest" or enterpriseServerVersions contains currentVersion %} | Receive {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %}{% data variables.product.prodname_dependabot_alerts %}{% else %}security alerts{% endif %} for vulnerable dependencies | "[About alerts for vulnerable dependencies](/github/managing-security-vulnerabilities/about-alerts-for-vulnerable-dependencies)" |{% endif %}{% if currentVersion == "free-pro-team@latest" %} @@ -76,7 +77,7 @@ Collaborators can also perform the following actions. | Submit a review on a pull request that affects the mergeability of the pull request | "[Reviewing proposed changes in a pull request](/github/collaborating-with-issues-and-pull-requests/reviewing-proposed-changes-in-a-pull-request)" | | Create and edit a wiki for the repository | "[About wikis](/github/building-a-strong-community/about-wikis)" | | Create and edit releases for the repository | "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository)" | -| Act as a code owner for the repository | "[About code owners](/articles/about-code-owners)" |{% if currentVersion == "free-pro-team@latest" %} +| Act as a code owner for the repository | "[About code owners](/articles/about-code-owners)" |{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" %} | Publish, view, or install packages | "[Publishing and managing packages](/github/managing-packages-with-github-packages/publishing-and-managing-packages)" |{% endif %} | Remove themselves as collaborators on the repository | "[Removing yourself from a collaborator's repository](/github/setting-up-and-managing-your-github-user-account/removing-yourself-from-a-collaborators-repository)" | diff --git a/content/github/site-policy/dmca-takedown-policy.md b/content/github/site-policy/dmca-takedown-policy.md index 7fbaf5fab8b5..c73627ff5d81 100644 --- a/content/github/site-policy/dmca-takedown-policy.md +++ b/content/github/site-policy/dmca-takedown-policy.md @@ -63,6 +63,8 @@ One of the best features of GitHub is the ability for users to "fork" one anothe GitHub *will not* automatically disable forks when disabling a parent repository. This is because forks belong to different users, may have been altered in significant ways, and may be licensed or used in a different way that is protected by the fair-use doctrine. GitHub does not conduct any independent investigation into forks. We expect copyright owners to conduct that investigation and, if they believe that the forks are also infringing, expressly include forks in their takedown notice. +In rare cases, you may be alleging copyright infringement in a full repository that is actively being forked. If at the time that you submitted your notice, you identified all existing forks of that repository as allegedly infringing, we would process a valid claim against all forks in that network at the time we process the notice. We would do this given the likelihood that all newly created forks would contain the same content. In addition, if the reported network that contains the allegedly infringing content is larger than one hundred (100) repositories and thus would be difficult to review in its entirety, we may consider disabling the entire network if you state in your notice that, "Based on the representative number of forks you have reviewed, I believe that all or most of the forks are infringing to the same extent as the parent repository." Your sworn statement would apply to this statement. + ### C. What If I Inadvertently Missed the Window to Make Changes? We recognize that there are many valid reasons that you may not be able to make changes within the window of approximately 1 business day we provide before your repository gets disabled. Maybe our message got flagged as spam, maybe you were on vacation, maybe you don't check that email account regularly, or maybe you were just busy. We get it. If you respond to let us know that you would have liked to make the changes, but somehow missed the first opportunity, we will re-enable the repository one additional time for approximately 1 business day to allow you to make the changes. Again, you must notify us that you have made the changes in order to keep the repository enabled after that window of approximately 1 business day, as noted above in [Step A.4](#a-how-does-this-actually-work). Please note that we will only provide this one additional chance. diff --git a/content/github/site-policy/github-subprocessors-and-cookies.md b/content/github/site-policy/github-subprocessors-and-cookies.md index fcb3e919454b..345953c1b991 100644 --- a/content/github/site-policy/github-subprocessors-and-cookies.md +++ b/content/github/site-policy/github-subprocessors-and-cookies.md @@ -50,6 +50,7 @@ Since the number and names of cookies may change, the table below may be updated | Service Provider | Cookie Name | Description | Expiration* | |:---|:---|:---|:---| | GitHub | `app_manifest_token` | This cookie is used during the App Manifest flow to maintain the state of the flow during the redirect to fetch a user session. | five minutes | +| GitHub | `color_mode` | This cookie is used to indicate the user selected theme preference. | session | | GitHub | `_device_id` | This cookie is used to track recognized devices for security purposes. | one year | | GitHub | `dotcom_user` | This cookie is used to signal to us that the user is already logged in. | one year | | GitHub | `_gh_ent` | This cookie is used for temporary application and framework state between pages like what step the customer is on in a multiple step form. | two weeks | diff --git a/content/github/site-policy/guide-to-submitting-a-dmca-takedown-notice.md b/content/github/site-policy/guide-to-submitting-a-dmca-takedown-notice.md index 65d7f81d864f..78989d611256 100644 --- a/content/github/site-policy/guide-to-submitting-a-dmca-takedown-notice.md +++ b/content/github/site-policy/guide-to-submitting-a-dmca-takedown-notice.md @@ -53,7 +53,8 @@ GitHub exercises little discretion in the process other than determining whether 2. **Identify the copyrighted work you believe has been infringed.** This information is important because it helps the affected user evaluate your claim and give them the ability to compare your work to theirs. The specificity of your identification will depend on the nature of the work you believe has been infringed. If you have published your work, you might be able to just link back to a web page where it lives. If it is proprietary and not published, you might describe it and explain that it is proprietary. If you have registered it with the Copyright Office, you should include the registration number. If you are alleging that the hosted content is a direct, literal copy of your work, you can also just explain that fact. -3. **Identify the material that you allege is infringing the copyrighted work listed in item #2, above.** It is important to be as specific as possible in your identification. This identification needs to be reasonably sufficient to permit GitHub to locate the material. At a minimum, this means that you should include the URL to the material allegedly infringing your copyright. If you allege that less than a whole repository infringes, identify the specific file(s) or line numbers within a file that you allege infringe. If you allege that all of the content at a URL infringes, please be explicit about that as well. Finally, please note that GitHub will *not* automatically disable [forks](/articles/dmca-takedown-policy#b-what-about-forks-or-whats-a-fork) when disabling a parent repository. If you have investigated and analyzed the forks of a repository and believe that they are also infringing, please explicitly identify each allegedly infringing fork. Please also confirm that you have investigated each individual case and that your sworn statements apply to each identified fork. +3. **Identify the material that you allege is infringing the copyrighted work listed in item #2, above.** It is important to be as specific as possible in your identification. This identification needs to be reasonably sufficient to permit GitHub to locate the material. At a minimum, this means that you should include the URL to the material allegedly infringing your copyright. If you allege that less than a whole repository infringes, identify the specific file(s) or line numbers within a file that you allege infringe. If you allege that all of the content at a URL infringes, please be explicit about that as well. + - Please note that GitHub will *not* automatically disable [forks](/articles/dmca-takedown-policy#b-what-about-forks-or-whats-a-fork) when disabling a parent repository. If you have investigated and analyzed the forks of a repository and believe that they are also infringing, please explicitly identify each allegedly infringing fork. Please also confirm that you have investigated each individual case and that your sworn statements apply to each identified fork. In rare cases, you may be alleging copyright infringement in a full repository that is actively being forked. If at the time that you submitted your notice, you identified all existing forks of that repository as allegedly infringing, we would process a valid claim against all forks in that network at the time we process the notice. We would do this given the likelihood that all newly created forks would contain the same content. In addition, if the reported network that contains the allegedly infringing content is larger than one hundred (100) repositories and thus would be difficult to review in its entirety, we may consider disabling the entire network if you state in your notice that, "Based on the representative number of forks you have reviewed, I believe that all or most of the forks are infringing to the same extent as the parent repository." Your sworn statement would apply to this statement. 4. **Explain what the affected user would need to do in order to remedy the infringement.** Again, specificity is important. When we pass your complaint along to the user, this will tell them what they need to do in order to avoid having the rest of their content disabled. Does the user just need to add a statement of attribution? Do they need to delete certain lines within their code, or entire files? Of course, we understand that in some cases, all of a user's content may be alleged to infringe and there's nothing they could do short of deleting it all. If that's the case, please make that clear as well. diff --git a/content/github/using-git/updating-credentials-from-the-macos-keychain.md b/content/github/using-git/updating-credentials-from-the-macos-keychain.md index 6e7675851231..f126ccd8c901 100644 --- a/content/github/using-git/updating-credentials-from-the-macos-keychain.md +++ b/content/github/using-git/updating-credentials-from-the-macos-keychain.md @@ -31,7 +31,7 @@ protocol=https > [Press Return] ``` -If it's successful, nothing will print out. To test that it works, try and clone a repository from {% data variables.product.product_location %}. If you are prompted for a password, the keychain entry was deleted. +If it's successful, nothing will print out. To test that it works, try and clone a private repository from {% data variables.product.product_location %}. If you are prompted for a password, the keychain entry was deleted. ### Further reading diff --git a/content/github/working-with-github-pages/changing-the-visibility-of-your-github-pages-site.md b/content/github/working-with-github-pages/changing-the-visibility-of-your-github-pages-site.md index 8f5f5a099d9c..bf7722bc937a 100644 --- a/content/github/working-with-github-pages/changing-the-visibility-of-your-github-pages-site.md +++ b/content/github/working-with-github-pages/changing-the-visibility-of-your-github-pages-site.md @@ -11,7 +11,14 @@ permissions: People with admin permissions for a repository can change the visib If your project site is published from a private or internal repository that's owned by an organization using {% data variables.product.prodname_ghe_cloud %}, you can manage access control for the site. With access control, you can choose to publish the site publicly to anyone on the internet or privately to people with read access to your repository. A privately published site can be used to share your internal documentation or knowledge base with members of your enterprise. You cannot manage access control for an organization site. For more information about the types of {% data variables.product.prodname_pages %} sites, see "[About GitHub Pages](/github/working-with-github-pages/about-github-pages#types-of-github-pages-sites)." -Privately published sites are available at a different subdomain than publicly published sites. You can see your site's URL in the repository settings. If you're using a static site generator configured to build the site with the repository name as a path, you may need to update the settings for the static site generator when changing the site to private. For more information, see "[Configuring Jekyll in your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain)" or the documentation for your static site generator. +Privately published sites are available at a different subdomain than publicly published sites. This ensures that your {% data variables.product.prodname_pages %} site is secure from the moment it's published: + +- We automatically secure every subdomain of `*.pages.github.io` with a TLS certificate, and enforce HSTS to ensure that browsers always serve the page over HTTPS. +- We use a unique subdomain for the private page to ensure that other repositories in your organization cannot publish content on the same origin as the private page. This protects your private page from "[cookie tossing](https://github.blog/2013-04-09-yummy-cookies-across-domains/)". This is also why we don't host {% data variables.product.prodname_pages %} sites on the `github.com` domain. + +You can see your site's unique subdomain in the pages tab of your repository settings. If you're using a static site generator configured to build the site with the repository name as a path, you may need to update the settings for the static site generator when changing the site to private. For more information, see "[Configuring Jekyll in your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain)" or the documentation for your static site generator. + +To use a shorter and more memorable domain for your private {% data variables.product.prodname_pages %} site, you can configure a custom domain. For more information, see "[Configuring a custom domain for your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/configuring-a-custom-domain-for-your-github-pages-site)." ### Changing the visibility of your {% data variables.product.prodname_pages %} site diff --git a/content/github/writing-on-github/basic-writing-and-formatting-syntax.md b/content/github/writing-on-github/basic-writing-and-formatting-syntax.md index 833bf2592f77..5886cb071772 100644 --- a/content/github/writing-on-github/basic-writing-and-formatting-syntax.md +++ b/content/github/writing-on-github/basic-writing-and-formatting-syntax.md @@ -197,7 +197,7 @@ For more information, see "[Autolinked references and URLs](/articles/autolinked Some {% data variables.product.prodname_github_app %}s provide information in {% data variables.product.product_name %} for URLs that link to their registered domains. {% data variables.product.product_name %} renders the information provided by the app under the URL in the body or comment of an issue or pull request. -![Content attachment](/assets/images/help/writing/content-attachment.png) +![Content attachment](/assets/images/github-apps/content_reference_attachment.png) To see content attachments, you must have a {% data variables.product.prodname_github_app %} that uses the Content Attachments API installed on the repository.{% if currentVersion == "free-pro-team@latest" %} For more information, see "[Installing an app in your personal account](/articles/installing-an-app-in-your-personal-account)" and "[Installing an app in your organization](/articles/installing-an-app-in-your-organization)."{% endif %} diff --git a/content/graphql/guides/forming-calls-with-graphql.md b/content/graphql/guides/forming-calls-with-graphql.md index 4a826e8d0e6d..6824e7129319 100644 --- a/content/graphql/guides/forming-calls-with-graphql.md +++ b/content/graphql/guides/forming-calls-with-graphql.md @@ -26,9 +26,10 @@ The following scopes are recommended: {% endif %} + ``` -user -public_repo +user{% if currentVersion != "github-ae@latest" %} +public_repo{% endif %} repo repo_deployment repo:status @@ -246,7 +247,7 @@ Looking at the composition line by line: The `labels` field has the type [`LabelConnection`](/graphql/reference/objects#labelconnection). As with the `issues` object, because `labels` is a connection, we must travel its edges to a connected node: the `label` object. At the node, we can specify the `label` object fields we want to return, in this case, `name`. -You may notice that running this query on the Octocat's public `Hello-World` repository won't return many labels. Try running it on one of your own repositories that does use labels, and you'll likely see a difference. +You may notice that running this query on the Octocat's {% if currentVersion != "github-ae@latest" %}public{% endif %} `Hello-World` repository won't return many labels. Try running it on one of your own repositories that does use labels, and you'll likely see a difference. ### Example mutation diff --git a/content/graphql/guides/managing-enterprise-accounts.md b/content/graphql/guides/managing-enterprise-accounts.md index edf73fa4494f..f77eb302657e 100644 --- a/content/graphql/guides/managing-enterprise-accounts.md +++ b/content/graphql/guides/managing-enterprise-accounts.md @@ -58,9 +58,7 @@ For some example queries, see "[An example query using the Enterprise Accounts A - `admin:enterprise`: Gives full control of enterprises (includes `manage_billing:enterprise` and `read:enterprise`) - `manage_billing:enterprise`: Read and write enterprise billing data. - `read:enterprise`: Read enterprise profile data. - - ![Permissions options for personal access token](/assets/images/developer/graphql/permissions-for-access-token.png) - + 4. Copy your personal access token and keep it in a secure place until you add it to your GraphQL client. #### 2. Choose a GraphQL client @@ -95,7 +93,9 @@ Now you are ready to start making queries. ### An example query using the Enterprise Accounts API -This GraphQL query requests the total number of `public` repositories in each of your appliance's organizations using the Enterprise Accounts API. To customize this query, replace `` with the slug of your Enterprise's instance slug. +This GraphQL query requests the total number of {% if currentVersion != "github-ae@latest" %}`public`{% else %}`private`{% endif %} repositories in each of your appliance's organizations using the Enterprise Accounts API. To customize this query, replace `` with the slug of your Enterprise's instance slug. + +{% if currentVersion != "github-ae@latest" %} ```graphql query publicRepositoriesByOrganization($slug: String!) { @@ -127,8 +127,42 @@ variables { } ``` -The next GraphQL query example shows how challenging it is to retrieve the number of `public` repositories in each organization without using the Enterprise Account API. Notice that the GraphQL Enterprise Accounts API has made this task simpler for enterprises since you only need to customize a single variable. To customize this query, replace `` and ``, etc. with the organization names on your instance. +{% else %} + +```graphql +query privateRepositoriesByOrganization($slug: String!) { + enterprise(slug: $slug) { + ...enterpriseFragment + } +} + +fragment enterpriseFragment on Enterprise { + ... on Enterprise{ + name + organizations(first: 100){ + nodes{ + name + ... on Organization{ + name + repositories(privacy: PRIVATE){ + totalCount + } + } + } + } + } +} + +# Passing our Enterprise Account as a variable +variables { + "slug": "" +} +``` +{% endif %} + +The next GraphQL query example shows how challenging it is to retrieve the number of {% if currentVersion != "github-ae@latest" %}`public`{% else %}`private`{% endif %} repositories in each organization without using the Enterprise Account API. Notice that the GraphQL Enterprise Accounts API has made this task simpler for enterprises since you only need to customize a single variable. To customize this query, replace `` and ``, etc. with the organization names on your instance. +{% if currentVersion != "github-ae@latest" %} ```graphql # Each organization is queried separately { @@ -150,9 +184,34 @@ fragment repositories on Organization { } } ``` +{% else %} +```graphql +# Each organization is queried separately +{ + organizationOneAlias: organization(login: "name-of-organization-one") { + # How to use a fragment + ...repositories + } + organizationTwoAlias: organization(login: "name-of-organization-two") { + ...repositories + } + # organizationThreeAlias ... and so on up-to lets say 100 +} + +## How to define a fragment +fragment repositories on Organization { + name + repositories(privacy: PRIVATE){ + totalCount + } +} +``` +{% endif %} ### Query each organization separately +{% if currentVersion != "github-ae@latest" %} + ```graphql query publicRepositoriesByOrganization { organizationOneAlias: organization(login: "") { @@ -173,6 +232,30 @@ fragment repositories on Organization { } ``` +{% else %} + +```graphql +query privateRepositoriesByOrganization { + organizationOneAlias: organization(login: "") { + # How to use a fragment + ...repositories + } + organizationTwoAlias: organization(login: "") { + ...repositories + } + # organizationThreeAlias ... and so on up-to lets say 100 +} +# How to define a fragment +fragment repositories on Organization { + name + repositories(privacy: PRIVATE){ + totalCount + } +} +``` + +{% endif %} + This GraphQL query requests the last 5 log entries for an enterprise organization. To customize this query, replace `` and ``. ```graphql diff --git a/content/graphql/guides/using-the-graphql-api-for-discussions.md b/content/graphql/guides/using-the-graphql-api-for-discussions.md index ad50406a5481..97837ee030c3 100644 --- a/content/graphql/guides/using-the-graphql-api-for-discussions.md +++ b/content/graphql/guides/using-the-graphql-api-for-discussions.md @@ -83,7 +83,7 @@ discussionCategories( ### Repository.discussion -Get a discussion. Returns `null` if discussion with the specified ID exists. +Get a discussion. Returns `null` if discussion with the specified ID does not exist. _Signature:_ diff --git a/content/insights/installing-and-configuring-github-insights/installing-github-insights.md b/content/insights/installing-and-configuring-github-insights/installing-github-insights.md index 18658d914df3..60e25e8f1a60 100644 --- a/content/insights/installing-and-configuring-github-insights/installing-github-insights.md +++ b/content/insights/installing-and-configuring-github-insights/installing-github-insights.md @@ -33,22 +33,22 @@ To connect {% data variables.product.prodname_insights %} to {% data variables.p {% data reusables.organizations.org_settings %} {% data reusables.organizations.github-apps-settings-sidebar %} 5. Click **New {% data variables.product.prodname_github_app %}**. - ![New GitHub App button](/assets/images/help/apps/github_apps_new.png) + ![New GitHub App button](/assets/images/github-apps/github_apps_new.png) 6. Under "{% data variables.product.prodname_github_app %} name", type a name for the app. Your app cannot have the same name as an existing user or organization, unless the name is your own user or organization name. - ![GitHub App name field](/assets/images/help/apps/github_apps_app_name.png) + ![GitHub App name field](/assets/images/github-apps/github_apps_app_name.png) 7. Under "Homepage URL", type the URL of the application server for {% data variables.product.prodname_insights %}. For more information, see "[System overview for {% data variables.product.prodname_insights %}](/insights/installing-and-configuring-github-insights/system-overview-for-github-insights#requirements-for-running-github-insights)." - ![Homepage URL field](/assets/images/help/apps/github_apps_homepage_url.png) + ![Homepage URL field](/assets/images/github-apps/github_apps_homepage_url.png) 8. Under "User authorization callback URL", type the following, replacing `` with the URL of the application server. ``` /public/applogin ``` - ![User authorization callback field](/assets/images/help/apps/github_apps_user_authorization.png) + ![User authorization callback field](/assets/images/github-apps/github_apps_user_authorization.png) 9. Under "Setup URL", type `/public/setup`. ![Setup URL field](/assets/images/help/apps/github-apps-setup-url.png) 9. Under "Webhook URL", type `/webhooks`. - ![Webhook URL field](/assets/images/help/apps/github_apps_webhook_url.png) + ![Webhook URL field](/assets/images/github-apps/github_apps_webhook_url.png) 10. Under "Webhook secret", type a secret, then record the secret for later reference. - ![Webhook secret field](/assets/images/help/apps/github_apps_webhook_secret.png) + ![Webhook secret field](/assets/images/github-apps/github_apps_webhook_secret.png) 11. Under "Permissions", use the drop-down menus and configure the following permissions for the app. - Repository: - Contents: **Read-only** @@ -71,7 +71,7 @@ To connect {% data variables.product.prodname_insights %} to {% data variables.p 13. To enable the {% data variables.product.prodname_github_app %} to access data from any user or organization in {% data variables.product.product_location %}, under "Where can this {% data variables.product.prodname_github_app %} be installed?", select **Any account**. ![Radio buttons to enable access to any account](/assets/images/help/apps/github_apps_installation_options_any_account.png) 14. Click **Create {% data variables.product.prodname_github_app %}**. - ![Create GitHub App button](/assets/images/help/apps/github_apps_create_github_app.png) + ![Create GitHub App button](/assets/images/github-apps/github_apps_create_github_app.png) 15. Review your app's configuration. 16. Under "Private keys", click **Generate a private key**. ![Generate a private key button](/assets/images/help/apps/generate-private-key.png) diff --git a/content/packages/guides/about-github-container-registry.md b/content/packages/guides/about-github-container-registry.md index 70ca2942cdfb..8d1ae3270842 100644 --- a/content/packages/guides/about-github-container-registry.md +++ b/content/packages/guides/about-github-container-registry.md @@ -74,7 +74,7 @@ To use or manage a package hosted by a package registry, you must use a token wi | --- | --- | |`read:packages`| Download and install container images from {% data variables.product.prodname_github_container_registry %} | |`write:packages`| Upload and publish container images to {% data variables.product.prodname_github_container_registry %} | -| `delete:packages` | Delete specified versions of private or public container images from {% data variables.product.prodname_github_container_registry %}. For more information, see "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.0" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}." | +| `delete:packages` | Delete specified versions of private or public container images from {% data variables.product.prodname_github_container_registry %}. For more information, see "[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package)." | To learn about available scopes and permissions for container images, see "[Configuring access control and visibility for container images](/packages/guides/configuring-access-control-and-visibility-for-container-images)." diff --git a/content/packages/guides/configuring-apache-maven-for-use-with-github-packages.md b/content/packages/guides/configuring-apache-maven-for-use-with-github-packages.md index 0ea1460fc77a..65df92a2b736 100644 --- a/content/packages/guides/configuring-apache-maven-for-use-with-github-packages.md +++ b/content/packages/guides/configuring-apache-maven-for-use-with-github-packages.md @@ -10,9 +10,11 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} {% data reusables.package_registry.admins-can-configure-package-types %} @@ -28,7 +30,7 @@ You can authenticate to {% data variables.product.prodname_registry %} with Apac In the `servers` tag, add a child `server` tag with an `id`, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, and *TOKEN* with your personal access token. -In the `repositories` tag, configure a repository by mapping the `id` of the repository to the `id` you added in the `server` tag containing your credentials. Replace {% if enterpriseServerVersions contains currentVersion %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance, {% endif %}*REPOSITORY* with the name of the repository you'd like to publish a package to or install a package from, and *OWNER* with the name of the user or organization account that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters. +In the `repositories` tag, configure a repository by mapping the `id` of the repository to the `id` you added in the `server` tag containing your credentials. Replace {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}*HOSTNAME* with the host name of {% data variables.product.product_location %}, {% endif %}*REPOSITORY* with the name of the repository you'd like to publish a package to or install a package from, and *OWNER* with the name of the user or organization account that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters. If you want to interact with multiple repositories, you can add each repository to separate `repository` children in the `repositories` tag, mapping the `id` of each to the credentials in the `servers` tag. @@ -55,13 +57,13 @@ If your instance has subdomain isolation enabled: central https://repo1.maven.org/maven2 - true - true github - GitHub OWNER Apache Maven Packages - https://{% if currentVersion == "free-pro-team@latest" %}maven.pkg.github.com{% else %}maven.HOSTNAME{% endif %}/OWNER/REPOSITORY + https://{% if currentVersion == "free-pro-team@latest" %}maven.pkg.github.com{% else %}maven.HOSTNAME{% endif %}/OWNER/* + + true + @@ -97,13 +99,13 @@ If your instance has subdomain isolation disabled: central https://repo1.maven.org/maven2 - true - true github - GitHub OWNER Apache Maven Packages - https://HOSTNAME/_registry/maven/OWNER/REPOSITORY + https://maven.pkg.github.com/OWNER/* + + true + @@ -132,7 +134,7 @@ If you would like to publish multiple packages to the same repository, you can i For more information on creating a package, see the [maven.apache.org documentation](https://maven.apache.org/guides/getting-started/maven-in-five-minutes.html). -1. Edit the `distributionManagement` element of the *pom.xml* file located in your package directory, replacing {% if enterpriseServerVersions contains currentVersion %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance, {% endif %}`OWNER` with the name of the user or organization account that owns the repository and `REPOSITORY` with the name of the repository containing your project. +1. Edit the `distributionManagement` element of the *pom.xml* file located in your package directory, replacing {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}*HOSTNAME* with the host name of {% data variables.product.product_location %}, {% endif %}`OWNER` with the name of the user or organization account that owns the repository and `REPOSITORY` with the name of the repository containing your project. {% if enterpriseServerVersions contains currentVersion %} If your instance has subdomain isolation enabled: {% endif %} @@ -190,4 +192,4 @@ To install an Apache Maven package from {% data variables.product.prodname_regis ### Further reading - "[Configuring Gradle for use with {% data variables.product.prodname_registry %}](/packages/guides/configuring-gradle-for-use-with-github-packages)" -- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.0" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}." +- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/content/packages/guides/configuring-docker-for-use-with-github-packages.md b/content/packages/guides/configuring-docker-for-use-with-github-packages.md index 0b46e533b12c..5b793e923636 100644 --- a/content/packages/guides/configuring-docker-for-use-with-github-packages.md +++ b/content/packages/guides/configuring-docker-for-use-with-github-packages.md @@ -10,9 +10,11 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} {% data reusables.package_registry.admins-can-configure-package-types %} @@ -48,9 +50,8 @@ To keep your credentials secure, we recommend you save your personal access toke {% endraw %} {% endif %} -{% if enterpriseServerVersions contains currentVersion %} - -{% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} +{% if currentVersion ver_gt "enterprise-server@2.22" %} If your instance has subdomain isolation enabled: {% endif %} {% raw %} @@ -58,7 +59,7 @@ If your instance has subdomain isolation enabled: $ cat ~/TOKEN.txt | docker login docker.HOSTNAME -u USERNAME --password-stdin ``` {% endraw %} -{% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion ver_gt "enterprise-server@2.22" %} If your instance has subdomain isolation disabled: {% raw %} @@ -70,7 +71,7 @@ If your instance has subdomain isolation disabled: {% endif %} -To use this example login command, replace `USERNAME` with your {% data variables.product.product_name %} username{% if enterpriseServerVersions contains currentVersion %}, `HOSTNAME` with the URL for {% data variables.product.product_location %},{% endif %} and `~/TOKEN.txt` with the file path to your personal access token for {% data variables.product.product_name %}. +To use this example login command, replace `USERNAME` with your {% data variables.product.product_name %} username{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}, `HOSTNAME` with the URL for {% data variables.product.product_location %},{% endif %} and `~/TOKEN.txt` with the file path to your personal access token for {% data variables.product.product_name %}. For more information, see "[Docker login](https://docs.docker.com/engine/reference/commandline/login/#provide-a-password-using-stdin)." @@ -99,40 +100,38 @@ For more information, see "[Docker login](https://docs.docker.com/engine/referen > REPOSITORY TAG IMAGE ID CREATED SIZE > IMAGE_NAME VERSION IMAGE_ID 4 weeks ago 1.11MB ``` -2. Using the Docker image ID, tag the docker image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% if enterpriseServerVersions contains currentVersion %} *HOSTNAME* with the hostname of {% data variables.product.product_location %},{% endif %} and *VERSION* with package version at build time. +2. Using the Docker image ID, tag the docker image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} *HOSTNAME* with the hostname of {% data variables.product.product_location %},{% endif %} and *VERSION* with package version at build time. {% if currentVersion == "free-pro-team@latest" %} ```shell $ docker tag IMAGE_ID docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% else %} - - {% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion ver_gt "enterprise-server@2.22" %} If your instance has subdomain isolation enabled: {% endif %} ```shell $ docker tag IMAGE_ID docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` - {% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion ver_gt "enterprise-server@2.22" %} If your instance has subdomain isolation disabled: ```shell $ docker tag IMAGE_ID HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% endif %} {% endif %} -3. If you haven't already built a docker image for the package, build the image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image, *VERSION* with package version at build time,{% if enterpriseServerVersions contains currentVersion %} *HOSTNAME* with the hostname of {% data variables.product.product_location %},{% endif %} and *PATH* to the image if it isn't in the current working directory. +3. If you haven't already built a docker image for the package, build the image, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image, *VERSION* with package version at build time,{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} *HOSTNAME* with the hostname of {% data variables.product.product_location %},{% endif %} and *PATH* to the image if it isn't in the current working directory. {% if currentVersion == "free-pro-team@latest" %} ```shell $ docker build -t docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH ``` {% else %} - - {% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion ver_gt "enterprise-server@2.22" %} If your instance has subdomain isolation enabled: {% endif %} ```shell $ docker build -t docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH ``` - {% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion ver_gt "enterprise-server@2.22" %} If your instance has subdomain isolation disabled: ```shell $ docker build -t HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION PATH @@ -145,14 +144,13 @@ For more information, see "[Docker login](https://docs.docker.com/engine/referen $ docker push docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` {% else %} - - {% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion ver_gt "enterprise-server@2.22" %} If your instance has subdomain isolation enabled: {% endif %} ```shell $ docker push docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION ``` - {% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} + {% if currentVersion ver_gt "enterprise-server@2.22" %} If your instance has subdomain isolation disabled: ```shell $ docker push HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:VERSION @@ -167,15 +165,10 @@ For more information, see "[Docker login](https://docs.docker.com/engine/referen #### Example publishing a Docker image -{% if enterpriseServerVersions contains currentVersion %} - -{% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion ver_gt "enterprise-server@2.22" %} These examples assume your instance has subdomain isolation enabled. {% endif %} - -{% endif %} - You can publish version 1.0 of the `monalisa` image to the `octocat/octo-app` repository using an image ID. {% if currentVersion == "free-pro-team@latest" %} @@ -236,7 +229,7 @@ $ docker push docker.HOSTNAME/octocat/octo-app/monalisa:1.0 {% data reusables.package_registry.docker_registry_deprecation_status %} -You can use the `docker pull` command to install a docker image from {% data variables.product.prodname_registry %}, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% if enterpriseServerVersions contains currentVersion %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance, {% endif %} and *TAG_NAME* with tag for the image you want to install. +You can use the `docker pull` command to install a docker image from {% data variables.product.prodname_registry %}, replacing *OWNER* with the name of the user or organization account that owns the repository, *REPOSITORY* with the name of the repository containing your project, *IMAGE_NAME* with name of the package or image,{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} *HOSTNAME* with the host name of {% data variables.product.product_location %}, {% endif %} and *TAG_NAME* with tag for the image you want to install. {% if currentVersion == "free-pro-team@latest" %} ```shell @@ -244,13 +237,13 @@ $ docker pull docker.pkg.github.com/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME -{% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion ver_gt "enterprise-server@2.22" %} If your instance has subdomain isolation enabled: {% endif %} ```shell $ docker pull docker.HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME ``` -{% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion ver_gt "enterprise-server@2.22" %} If your instance has subdomain isolation disabled: ```shell $ docker pull HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME @@ -266,4 +259,4 @@ $ docker pull HOSTNAME/OWNER/REPOSITORY/IMAGE_NAME:TAG_NAME ### Further reading -- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.0" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}." +- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/content/packages/guides/configuring-dotnet-cli-for-use-with-github-packages.md b/content/packages/guides/configuring-dotnet-cli-for-use-with-github-packages.md index 3a48e2e9ab2c..b8e5b0a4fde5 100644 --- a/content/packages/guides/configuring-dotnet-cli-for-use-with-github-packages.md +++ b/content/packages/guides/configuring-dotnet-cli-for-use-with-github-packages.md @@ -11,9 +11,11 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} {% data reusables.package_registry.admins-can-configure-package-types %} @@ -30,10 +32,10 @@ To authenticate to {% data variables.product.prodname_registry %} with the `dotn You must replace: - `USERNAME` with the name of your user account on {% data variables.product.prodname_dotcom %}. - `TOKEN` with your personal access token. -- `OWNER` with the name of the user or organization account that owns the repository containing your project.{% if enterpriseServerVersions contains currentVersion %} -- `HOSTNAME` with the host name for your {% data variables.product.prodname_ghe_server %} instance. +- `OWNER` with the name of the user or organization account that owns the repository containing your project.{%if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} +- `HOSTNAME` with the host name for {% data variables.product.product_location %}.{% endif %} -If your instance has subdomain isolation enabled: +{%if enterpriseServerVersions contains currentVersion %}If your instance has subdomain isolation enabled: {% endif %} ```xml @@ -78,9 +80,9 @@ If your instance has subdomain isolation disabled: ### Publishing a package -You can publish a package to {% data variables.product.prodname_registry %} by authenticating with a *nuget.config* file{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}, or by using the `--api-key` command line option with your {% data variables.product.prodname_dotcom %} personal access token (PAT){% endif %}. +You can publish a package to {% data variables.product.prodname_registry %} by authenticating with a *nuget.config* file{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest"%}, or by using the `--api-key` command line option with your {% data variables.product.prodname_dotcom %} personal access token (PAT){% endif %}. -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} #### Publishing a package using a GitHub PAT as your API key If you don't already have a PAT to use for your {% data variables.product.prodname_dotcom %} account, see "[Creating a personal access token](/github/authenticating-to-github/creating-a-personal-access-token)." @@ -115,8 +117,8 @@ When publishing, you need to use the same value for `OWNER` in your *csproj* fil 3. Add your project's specific information to your project's file, which ends in *.csproj*. You must replace: - `OWNER` with the name of the user or organization account that owns the repository containing your project. - `REPOSITORY` with the name of the repository containing the package you want to publish. - - `1.0.0` with the version number of the package.{% if enterpriseServerVersions contains currentVersion %} - - `HOSTNAME` with the host name for your {% data variables.product.prodname_ghe_server %} instance.{% endif %} + - `1.0.0` with the version number of the package.{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} + - `HOSTNAME` with the host name for {% data variables.product.product_location %}.{% endif %} ``` xml @@ -220,4 +222,4 @@ Using packages from {% data variables.product.prodname_dotcom %} in your project ### Further reading -- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.0" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}." +- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/content/packages/guides/configuring-gradle-for-use-with-github-packages.md b/content/packages/guides/configuring-gradle-for-use-with-github-packages.md index eb3d6632f7b8..c144f63b6df1 100644 --- a/content/packages/guides/configuring-gradle-for-use-with-github-packages.md +++ b/content/packages/guides/configuring-gradle-for-use-with-github-packages.md @@ -10,9 +10,11 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} {% data reusables.package_registry.admins-can-configure-package-types %} @@ -28,6 +30,8 @@ You can authenticate to {% data variables.product.prodname_registry %} with Grad {% if enterpriseServerVersions contains currentVersion %} Replace *REGISTRY-URL* with the URL for your instance's Maven registry. If your instance has subdomain isolation enabled, use `maven.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/maven`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance. +{% elsif currentVersion == "github-ae@latest" %} +Replace *REGISTRY-URL* with the URL for your enterprise's Maven registry, `maven.HOSTNAME`. Replace *HOSTNAME* with the host name of {% data variables.product.product_location %}. {% endif %} Replace *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, *REPOSITORY* with the name of the repository containing the package you want to publish, and *OWNER* with the name of the user or organization account on {% data variables.product.prodname_dotcom %} that owns the repository. Because uppercase letters aren't supported, you must use lowercase letters for the repository owner even if the {% data variables.product.prodname_dotcom %} user or organization name contains uppercase letters. @@ -211,4 +215,4 @@ You can install a package by adding the package as a dependency to your project. ### Further reading - "[Configuring Apache Maven for use with {% data variables.product.prodname_registry %}](/packages/using-github-packages-with-your-projects-ecosystem/configuring-apache-maven-for-use-with-github-packages)" -- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.0" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}." +- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/content/packages/guides/configuring-npm-for-use-with-github-packages.md b/content/packages/guides/configuring-npm-for-use-with-github-packages.md index 661a4a6c6e37..ef6474ff3525 100644 --- a/content/packages/guides/configuring-npm-for-use-with-github-packages.md +++ b/content/packages/guides/configuring-npm-for-use-with-github-packages.md @@ -10,20 +10,22 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} {% data reusables.package_registry.admins-can-configure-package-types %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ### Limits for published npm versions If you publish over 1,000 npm package versions to {% data variables.product.prodname_registry %}, you may see performance issues and timeouts occur during usage. In the future, to improve performance of the service, you won't be able to publish more than 1,000 versions of a package on {% data variables.product.prodname_dotcom %}. Any versions published before hitting this limit will still be readable. -If you reach this limit, consider deleting package versions or contact Support for help. When this limit is enforced, our documentation will be updated with a way to work around this limit. For more information, see "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.0" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" or "[Contacting Support](/packages/learn-github-packages/about-github-packages#contacting-support)." +If you reach this limit, consider deleting package versions or contact Support for help. When this limit is enforced, our documentation will be updated with a way to work around this limit. For more information, see "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" or "[Contacting Support](/packages/learn-github-packages/about-github-packages#contacting-support)." {% endif %} @@ -37,7 +39,7 @@ If you reach this limit, consider deleting package versions or contact Support f You can authenticate to {% data variables.product.prodname_registry %} with npm by either editing your per-user *~/.npmrc* file to include your personal access token or by logging in to npm on the command line using your username and personal access token. -To authenticate by adding your personal access token to your *~/.npmrc* file, edit the *~/.npmrc* file for your project to include the following line, replacing {% if enterpriseServerVersions contains currentVersion %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance and {% endif %}*TOKEN* with your personal access token. Create a new *~/.npmrc* file if one doesn't exist. +To authenticate by adding your personal access token to your *~/.npmrc* file, edit the *~/.npmrc* file for your project to include the following line, replacing {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}*HOSTNAME* with the host name of {% data variables.product.product_location %} and {% endif %}*TOKEN* with your personal access token. Create a new *~/.npmrc* file if one doesn't exist. {% if enterpriseServerVersions contains currentVersion %} If your instance has subdomain isolation enabled: @@ -183,7 +185,7 @@ You also need to add the *.npmrc* file to your project so all requests to instal #### Installing packages from other organizations -By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your *.npmrc* file, replacing {% if enterpriseServerVersions contains currentVersion %}*HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance and {% endif %}*OWNER* with the name of the user or organization account that owns the repository containing your project. +By default, you can only use {% data variables.product.prodname_registry %} packages from one organization. If you'd like to route package requests to multiple organizations and users, you can add additional lines to your *.npmrc* file, replacing {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %}*HOSTNAME* with the host name of {% data variables.product.product_location %} and {% endif %}*OWNER* with the name of the user or organization account that owns the repository containing your project. {% if enterpriseServerVersions contains currentVersion %} If your instance has subdomain isolation enabled: @@ -205,7 +207,7 @@ registry=https://HOSTNAME/_registry/npm/OWNER ``` {% endif %} -{% if currentVersion == "enterprise-server@3.0" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion ver_gt "enterprise-server@2.22" %} ### Using the official NPM registry {% data variables.product.prodname_registry %} allows you to access the official NPM registry at `registry.npmjs.com`, if your {% data variables.product.prodname_ghe_server %} administrator has enabled this feature. For more information, see [Connecting to the official NPM registry](/admin/packages/configuring-packages-support-for-your-enterprise#connecting-to-the-official-npm-registry). @@ -213,4 +215,4 @@ registry=https://HOSTNAME/_registry/npm/OWNER ### Further reading -- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.0" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}." +- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/content/packages/guides/configuring-rubygems-for-use-with-github-packages.md b/content/packages/guides/configuring-rubygems-for-use-with-github-packages.md index 95ee9b221ce7..5a045c462958 100644 --- a/content/packages/guides/configuring-rubygems-for-use-with-github-packages.md +++ b/content/packages/guides/configuring-rubygems-for-use-with-github-packages.md @@ -10,9 +10,11 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} {% data reusables.package_registry.admins-can-configure-package-types %} @@ -59,6 +61,8 @@ To install gems, you need to authenticate to {% data variables.product.prodname_ - `TOKEN` with your personal access token. - `OWNER` with the name of the user or organization account that owns the repository containing your project.{% if enterpriseServerVersions contains currentVersion %} - `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance. +{% elsif currentVersion == "github-ae@latest" %} + - `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}. {% endif %} If you don't have a *~/.gemrc* file, create a new *~/.gemrc* file using this example. @@ -75,7 +79,7 @@ If you don't have a *~/.gemrc* file, create a new *~/.gemrc* file using this exa ``` -To authenticate with Bundler, configure Bundler to use your personal access token, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, and *OWNER* with the name of the user or organization account that owns the repository containing your project.{% if enterpriseServerVersions contains currentVersion %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance.{% endif %} +To authenticate with Bundler, configure Bundler to use your personal access token, replacing *USERNAME* with your {% data variables.product.prodname_dotcom %} username, *TOKEN* with your personal access token, and *OWNER* with the name of the user or organization account that owns the repository containing your project.{% if enterpriseServerVersions contains currentVersion %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the hostname of your {% data variables.product.prodname_ghe_server %} instance.{% elsif currentVersion == "github-ae@latest" %}Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}.{% endif %} ```shell $ bundle config https://{% if currentVersion == "free-pro-team@latest" %}rubygems.pkg.github.com{% else %}REGISTRY-URL{% endif %}/OWNER USERNAME:TOKEN @@ -96,7 +100,7 @@ $ bundle config https://{% if currentVersion == "free-pro-team@latest" %}rubygem ```shell gem build OCTO-GEM.gemspec ``` -3. Publish a package to {% data variables.product.prodname_registry %}, replacing `OWNER` with the name of the user or organization account that owns the repository containing your project and `OCTO-GEM` with the name of your gem package.{% if enterpriseServerVersions contains currentVersion %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% endif %} +3. Publish a package to {% data variables.product.prodname_registry %}, replacing `OWNER` with the name of the user or organization account that owns the repository containing your project and `OCTO-GEM` with the name of your gem package.{% if enterpriseServerVersions contains currentVersion %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% elsif currentVersion == "github-ae@latest" %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}.{% endif %} ```shell $ gem push --key github \ @@ -106,7 +110,7 @@ $ bundle config https://{% if currentVersion == "free-pro-team@latest" %}rubygem ### Publishing multiple packages to the same repository -To publish multiple gems to the same repository, you can include the URL to the {% data variables.product.prodname_dotcom %} repository in the `github_repo` field in `gem.metadata`. If you include this field, {% data variables.product.prodname_dotcom %} matches the repository based on this value, instead of using the gem name.{% if enterpriseServerVersions contains currentVersion %} Replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% endif %} +To publish multiple gems to the same repository, you can include the URL to the {% data variables.product.prodname_dotcom %} repository in the `github_repo` field in `gem.metadata`. If you include this field, {% data variables.product.prodname_dotcom %} matches the repository based on this value, instead of using the gem name.{% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} Replace *HOSTNAME* with the host name of {% data variables.product.product_location %}.{% endif %} ```ruby gem.metadata = { "github_repo" => "ssh://{% if currentVersion == "free-pro-team@latest" %}github.com{% else %}HOSTNAME{% endif %}/OWNER/REPOSITORY" } @@ -117,7 +121,7 @@ gem.metadata = { "github_repo" => "ssh://{% if currentVersion == "free-pro-team@ You can use gems from {% data variables.product.prodname_registry %} much like you use gems from *rubygems.org*. You need to authenticate to {% data variables.product.prodname_registry %} by adding your {% data variables.product.prodname_dotcom %} user or organization as a source in the *~/.gemrc* file or by using Bundler and editing you *Gemfile*. {% data reusables.package_registry.authenticate-step %} -2. For Bundler, add your {% data variables.product.prodname_dotcom %} user or organization as a source in your *Gemfile* to fetch gems from this new source. For example, you can add a new `source` block to your *Gemfile* that uses {% data variables.product.prodname_registry %} only for the packages you specify, replacing *GEM NAME* with the package you want to install from {% data variables.product.prodname_registry %} and *OWNER* with the user or organization that owns the repository containing the gem you want to install.{% if enterpriseServerVersions contains currentVersion %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% endif %} +1. For Bundler, add your {% data variables.product.prodname_dotcom %} user or organization as a source in your *Gemfile* to fetch gems from this new source. For example, you can add a new `source` block to your *Gemfile* that uses {% data variables.product.prodname_registry %} only for the packages you specify, replacing *GEM NAME* with the package you want to install from {% data variables.product.prodname_registry %} and *OWNER* with the user or organization that owns the repository containing the gem you want to install.{% if enterpriseServerVersions contains currentVersion %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry. If your instance has subdomain isolation enabled, use `rubygems.HOSTNAME`. If your instance has subdomain isolation disabled, use `HOSTNAME/_registry/rubygems`. In either case, replace *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance.{% elsif currentVersion == "github-ae@latest" %} Replace `REGISTRY-URL` with the URL for your instance's Rubygems registry, `rubygems.HOSTNAME`. Replace *HOSTNAME* with the hostname of {% data variables.product.product_location %}.{% endif %} ```ruby source "https://rubygems.org" @@ -146,4 +150,4 @@ You can use gems from {% data variables.product.prodname_registry %} much like y ### Further reading -- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.0" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}." +- "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" diff --git a/content/packages/guides/container-guides-for-github-packages.md b/content/packages/guides/container-guides-for-github-packages.md index 31b8f63889a5..1b482e040ab8 100644 --- a/content/packages/guides/container-guides-for-github-packages.md +++ b/content/packages/guides/container-guides-for-github-packages.md @@ -6,5 +6,6 @@ mapTopic: true versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- diff --git a/content/packages/guides/index.md b/content/packages/guides/index.md index f7aefb201f62..923574422eb1 100644 --- a/content/packages/guides/index.md +++ b/content/packages/guides/index.md @@ -8,9 +8,11 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} ### Table of Contents diff --git a/content/packages/guides/package-client-guides-for-github-packages.md b/content/packages/guides/package-client-guides-for-github-packages.md index 6f77e8b9bd3e..27432d071799 100644 --- a/content/packages/guides/package-client-guides-for-github-packages.md +++ b/content/packages/guides/package-client-guides-for-github-packages.md @@ -6,5 +6,6 @@ mapTopic: true versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- diff --git a/content/packages/guides/using-github-packages-with-github-actions.md b/content/packages/guides/using-github-packages-with-github-actions.md index 8f9a3f5c6d7a..f04d9c2b5b6b 100644 --- a/content/packages/guides/using-github-packages-with-github-actions.md +++ b/content/packages/guides/using-github-packages-with-github-actions.md @@ -8,9 +8,13 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} +{% data reusables.actions.ae-beta %} +{% data reusables.actions.ae-self-hosted-runners-notice %} ### About {% data variables.product.prodname_registry %} with {% data variables.product.prodname_actions %} @@ -45,7 +49,7 @@ The following example demonstrates how you can use {% data variables.product.pro - Create a new workflow file in your repository (such as `.github/workflows/deploy-image.yml`), and add the following YAML: {% raw %} - ``` + ```yaml{:copy} name: Create and publish a package on: push: @@ -99,7 +103,7 @@ The following example demonstrates how you can use {% data variables.product.pro with: username: ${{ github.actor }} password: ${{ secrets.GITHUB_TOKEN }} - registry: docker.pkg.github.com + registry: {% endraw %}{% if currentVersion == "github-ae@latest" %}docker.YOUR-HOSTNAME.com{% else %}docker.pkg.github.com{% endif %}{% raw %} repository: ${{ github.repository }}/octo-image tag_with_sha: true tag_with_ref: true @@ -251,14 +255,12 @@ password: ${{ secrets.GITHUB_TOKEN }} -{% raw %} ```yaml -registry: docker.pkg.github.com +registry: {% if currentVersion == "github-ae@latest" %}docker.YOUR-HOSTNAME.com{% else %}docker.pkg.github.com{% endif %} ``` -{% endraw %} - Defines the registry that will host the resulting packages. This example uses {% data variables.product.prodname_registry %}. + Defines the registry that will host the resulting packages. This example uses {% data variables.product.prodname_registry %}.{% if currentVersion == "github-ae@latest" %} Replace YOUR-HOSTNAME with the name of your enterprise.{% endif %} @@ -302,7 +304,7 @@ tag_with_ref: true -- This new workflow will run automatically every time you push a change to the repository. You can view the progress in the **Actions** tab. +- This new workflow will run automatically every time you push a change to a branch named `release` in the repository. You can view the progress in the **Actions** tab. - A few minutes after the workflow has completed, the new package will visible in your repository. To find your available packages, see "[Viewing a repository's packages](/packages/publishing-and-managing-packages/viewing-packages#viewing-a-repositorys-packages)." ### Installing a package using an action diff --git a/content/packages/index.md b/content/packages/index.md index 46b610207453..14afebfca805 100644 --- a/content/packages/index.md +++ b/content/packages/index.md @@ -37,6 +37,7 @@ layout: product-landing versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- diff --git a/content/packages/learn-github-packages/about-github-packages.md b/content/packages/learn-github-packages/about-github-packages.md index 68a5a00f5df5..b9b21493b842 100644 --- a/content/packages/learn-github-packages/about-github-packages.md +++ b/content/packages/learn-github-packages/about-github-packages.md @@ -1,6 +1,6 @@ --- title: About GitHub Packages -intro: '{% data variables.product.prodname_registry %} is a software package hosting service that allows you to host your software packages privately or publicly and use packages as dependencies in your projects.' +intro: '{% data variables.product.prodname_registry %} is a software package hosting service that allows you to host your software packages privately {% if currentVersion == "github-ae@latest" %} for specified users or internally for your enterprise{% else %}or publicly{% endif %} and use packages as dependencies in your projects.' product: '{% data reusables.gated-features.packages %}' redirect_from: - /articles/about-github-package-registry @@ -10,13 +10,15 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} ### About {% data variables.product.prodname_registry %} -{% data variables.product.prodname_registry %} is a platform for hosting and managing packages, including containers and other dependencies. {% data variables.product.prodname_registry %} combines your source code and packages in one place to provide integrated permissions management and billing, so you can centralize your software development on {% data variables.product.product_name %}. +{% data variables.product.prodname_registry %} is a platform for hosting and managing packages, including containers and other dependencies. {% data variables.product.prodname_registry %} combines your source code and packages in one place to provide integrated permissions management{% if currentVersion != "github-ae@latest" %} and billing{% endif %}, so you can centralize your software development on {% data variables.product.product_name %}. You can integrate {% data variables.product.prodname_registry %} with {% data variables.product.product_name %} APIs, {% data variables.product.prodname_actions %}, and webhooks to create an end-to-end DevOps workflow that includes your code, CI, and deployment solutions. @@ -63,52 +65,16 @@ You can review the package's README, some metadata like licensing, download stat {% data variables.product.prodname_registry %} uses the native package tooling commands you're already familiar with to publish and install package versions. #### Support for package registries -{% if currentVersion == "free-pro-team@latest" %} -Package registries use `PACKAGE-TYPE.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME` as the package host URL, replacing `PACKAGE-TYPE` with the Package namespace. For example, your Gemfile will be hosted at `rubygems.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME`. - -{% else %} - -The package types supported on {% data variables.product.product_location %} may vary since your site administrator can enable or disable support for different package types. For more information, see "[Managing GitHub Packages for your enterprise](/enterprise/admin/packages)." - -If {% data variables.product.product_location %} has subdomain isolation enabled, then package registries will use `PACKAGE-TYPE.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME` as the package host URL, replacing `PACKAGE-TYPE` with the Package namespace. For example, your Dockerfile will be hosted at `docker.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME`. - -If {% data variables.product.product_location %} has subdomain isolation disabled, then package registries will use `HOSTNAME/_registry/PACKAGE-TYPE/OWNER/REPOSITORY/IMAGE-NAME` as the package host URL. For example, your Gemfile will be hosted at `HOSTNAME/_registry/rubygems/OWNER/REPOSITORY/IMAGE-NAME`, replacing *HOSTNAME* with the host name of your {% data variables.product.prodname_ghe_server %} instance. - -{% endif %} - -{% if currentVersion == "free-pro-team@latest" %} - -| Language | Description | Package format | Package client | Package namespace | -| --- | --- | --- | --- | --- | -| JavaScript | Node package manager | `package.json` | `npm` | `npm.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME` -| Ruby | RubyGems package manager | `Gemfile` | `gem` | `rubygems.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME` -| Java | Apache Maven project management and comprehension tool | `pom.xml` | `mvn` | `maven.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME` -| Java | Gradle build automation tool for Java | `build.gradle` or `build.gradle.kts` | `gradle` | `maven.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME` -| .NET | NuGet package management for .NET | `nupkg` | `dotnet` CLI | `nuget.pkg.github.com/OWNER/REPOSITORY/IMAGE-NAME` - -{% else %} - -With subdomain isolation enabled on {% data variables.product.product_location %}: - -| Language | Description | Package format | Package client | Package namespace | -| --- | --- | --- | --- | --- | -| JavaScript | Node package manager | `package.json` | `npm` | `npm.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME` -| Ruby | RubyGems package manager | `Gemfile` | `gem` | `rubygems.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME` -| Java | Apache Maven project management and comprehension tool | `pom.xml` | `mvn` | `maven.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME` -| Java | Gradle build automation tool for Java | `build.gradle` or `build.gradle.kts` | `gradle` | `maven.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME` -| .NET | NuGet package management for .NET | `nupkg` | `dotnet` CLI | `nuget.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME` -| N/A | Docker container management | `Dockerfile` | `Docker` | `docker.HOSTNAME/OWNER/REPOSITORY/IMAGE-NAME` - -With subdomain isolation disabled on {% data variables.product.product_location %}: - -| Language | Description | Package format | Package client | Package namespace | -| --- | --- | --- | --- | --- | -| JavaScript | Node package manager | `package.json` | `npm` | `HOSTNAME/_registry/npm/OWNER/REPOSITORY/IMAGE-NAME` -| Ruby | RubyGems package manager | `Gemfile` | `gem` | `HOSTNAME/_registry/rubygems/OWNER/REPOSITORY/IMAGE-NAME` -| Java | Apache Maven project management and comprehension tool | `pom.xml` | `mvn` | `HOSTNAME/_registry/maven/OWNER/REPOSITORY/IMAGE-NAME` -| Java | Gradle build automation tool for Java | `build.gradle` or `build.gradle.kts` | `gradle` | `HOSTNAME/_registry/maven/OWNER/REPOSITORY/IMAGE-NAME` -| .NET | NuGet package management for .NET | `nupkg` | `dotnet` CLI | `HOSTNAME/_registry/nuget/OWNER/REPOSITORY/IMAGE-NAME` +| Language | Description | Package format | Package client | +| --- | --- | --- | --- | +| JavaScript | Node package manager | `package.json` | `npm` | +| Ruby | RubyGems package manager | `Gemfile` | `gem` | +| Java | Apache Maven project management and comprehension tool | `pom.xml` | `mvn` | +| Java | Gradle build automation tool for Java | `build.gradle` or `build.gradle.kts` | `gradle` | +| .NET | NuGet package management for .NET | `nupkg` | `dotnet` CLI | +| N/A | Docker container management | `Dockerfile` | `Docker` | +{% if currentVersion ver_gt "enterprise-server@2.22" %} {% note %} **Note:** Docker is not supported when subdomain isolation is disabled. @@ -134,13 +100,13 @@ To use or manage a package hosted by a package registry, you must use a token wi For example: - To download and install packages from a repository, your token must have the `read:packages` scope, and your user account must have read permissions for the repository. -- {% if currentVersion == "free-pro-team@latest" or if currentVersion ver_gt "enterprise-server@3.0" %}To delete a package on {% data variables.product.product_name %}, your token must at least have the `delete:packages` and `read:packages` scope. The `repo` scope is also required for repo-scoped packages.{% endif %}{% if currentVersion ver_lt "enterprise-server@3.1" %}To delete a specified version of a private package on {% data variables.product.product_name %}, your token must have the `delete:packages` and `repo` scope. Public packages cannot be deleted.{% endif %} For more information, see "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}." +- {% if currentVersion == "free-pro-team@latest" or if currentVersion ver_gt "enterprise-server@3.0" %}To delete a package on {% data variables.product.product_name %}, your token must at least have the `delete:packages` and `read:packages` scope. The `repo` scope is also required for repo-scoped packages.{% elsif currentVersion ver_lt "enterprise-server@3.1" %}To delete a specified version of a private package on {% data variables.product.product_name %}, your token must have the `delete:packages` and `repo` scope. Public packages cannot be deleted.{% elsif currentVersion == "github-ae@latest" %}To delete a specified version of a package on {% data variables.product.product_name %}, your token must have the `delete:packages` and `repo` scope.{% endif %} For more information, see "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}." | Scope | Description | Repository permissions | | --- | --- | --- | |`read:packages`| Download and install packages from {% data variables.product.prodname_registry %} | read | |`write:packages`| Upload and publish packages to {% data variables.product.prodname_registry %} | write | -| `delete:packages` | {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} Delete packages from {% data variables.product.prodname_registry %} {% endif %}{% if currentVersion ver_lt "enterprise-server@3.1" %} Delete specified versions of private packages from {% data variables.product.prodname_registry %} {% endif %} | admin | +| `delete:packages` | {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} Delete packages from {% data variables.product.prodname_registry %} {% elsif currentVersion ver_lt "enterprise-server@3.1" %} Delete specified versions of private packages from {% data variables.product.prodname_registry %}{% elsif currentVersion == "github-ae@latest" %} Delete specified versions of packages from {% data variables.product.prodname_registry %} {% endif %} | admin | | `repo` | Upload and delete packages (along with `write:packages`, or `delete:packages`) | write, or admin | When you create a {% data variables.product.prodname_actions %} workflow, you can use the `GITHUB_TOKEN` to publish and install packages in {% data variables.product.prodname_registry %} without needing to store and manage a personal access token. @@ -164,7 +130,11 @@ You can delete a private or public package in the {% data variables.product.prod You can delete a version of a private package in the {% data variables.product.product_name %} user interface or using the GraphQL API. {% endif %} -When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" and "[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." +{% if currentVersion == "github-ae@latest" %} +You can delete a version of a package in the {% data variables.product.product_name %} user interface or using the GraphQL API. +{% endif %} + +When you use the GraphQL API to query and delete private packages, you must use the same token you use to authenticate to {% data variables.product.prodname_registry %}. For more information, see "{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}[Deleting and restoring a package](/packages/learn-github-packages/deleting-and-restoring-a-package){% elsif currentVersion ver_lt "enterprise-server@3.1" or currentVersion == "github-ae@latest" %}[Deleting a package](/packages/learn-github-packages/deleting-a-package){% endif %}" and "[Forming calls with GraphQL](/graphql/guides/forming-calls-with-graphql)." You can configure webhooks to subscribe to package-related events, such as when a package is published or updated. For more information, see the "[`package` webhook event](/webhooks/event-payloads/#package)." diff --git a/content/packages/learn-github-packages/core-concepts-for-github-packages.md b/content/packages/learn-github-packages/core-concepts-for-github-packages.md index 07b7774cd7fc..25a14cbc947a 100644 --- a/content/packages/learn-github-packages/core-concepts-for-github-packages.md +++ b/content/packages/learn-github-packages/core-concepts-for-github-packages.md @@ -7,9 +7,11 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} ### Package diff --git a/content/packages/learn-github-packages/deleting-a-package.md b/content/packages/learn-github-packages/deleting-a-package.md index 0a09d23e8b4e..d23b0e652e42 100644 --- a/content/packages/learn-github-packages/deleting-a-package.md +++ b/content/packages/learn-github-packages/deleting-a-package.md @@ -1,20 +1,22 @@ --- title: Deleting a package -intro: 'You can delete a version of a private package using GraphQL or on {% data variables.product.product_name %}.' +intro: 'You can delete a version of a {% if currentVersion != "github-ae@latest" %}private{% endif %} package using GraphQL or on {% data variables.product.product_name %}.' product: '{% data reusables.gated-features.packages %}' versions: enterprise-server: '>=2.22 <3.1' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} -At this time, {% data variables.product.prodname_registry %} on {% data variables.product.product_location %} does not support deleting public packages. +{% if currentVersion != "github-ae@latest" %}At this time, {% data variables.product.prodname_registry %} on {% data variables.product.product_location %} does not support deleting public packages.{% endif %} -You can only delete a specified version of a private package on {% data variables.product.product_name %} or with the GraphQL API. To remove an entire private package from appearing on {% data variables.product.product_name %}, you must delete every version of the package first. +You can only delete a specified version of a {% if currentVersion != "github-ae@latest" %}private {% endif %}package on {% data variables.product.product_name %} or with the GraphQL API. To remove an entire {% if currentVersion != "github-ae@latest" %}private {% endif %}package from appearing on {% data variables.product.product_name %}, you must delete every version of the package first. -### Deleting a version of a private package on {% data variables.product.product_name %} +### Deleting a version of a {% if currentVersion != "github-ae@latest" %}private {% endif %}package on {% data variables.product.product_name %} -To delete a private package version, you must have admin permissions in the repository. +To delete a {% if currentVersion != "github-ae@latest" %}private {% endif %}package version, you must have admin permissions in the repository. {% data reusables.repositories.navigate-to-repo %} {% data reusables.package_registry.packages-from-code-tab %} @@ -27,7 +29,7 @@ To delete a private package version, you must have admin permissions in the repo 6. To confirm deletion, type the package name and click **I understand the consequences, delete this version**. ![Confirm package deletion button](/assets/images/help/package-registry/confirm-package-deletion.png) -### Deleting a version of a private package with GraphQL +### Deleting a version of a {% if currentVersion != "github-ae@latest" %}private {% endif %}package with GraphQL Use the `deletePackageVersion` mutation in the GraphQL API. You must use a token with the `read:packages`, `delete:packages`, and `repo` scopes. For more information about tokens, see "[About {% data variables.product.prodname_registry %}](/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages)." @@ -41,7 +43,7 @@ curl -X POST \ HOSTNAME/graphql ``` -To find all of the private packages you have published to {% data variables.product.prodname_registry %}, along with the version IDs for the packages, you can use the `packages` connection through the `repository` object. You will need a token with the `read:packages` and `repo` scopes. For more information, see the [`packages`](/graphql/reference/objects#repository) connection or the [`PackageOwner`](/graphql/reference/interfaces#packageowner) interface. +To find all of the {% if currentVersion != "github-ae@latest" %}private {% endif %}packages you have published to {% data variables.product.prodname_registry %}, along with the version IDs for the packages, you can use the `packages` connection through the `repository` object. You will need a token with the `read:packages` and `repo` scopes. For more information, see the [`packages`](/graphql/reference/objects#repository) connection or the [`PackageOwner`](/graphql/reference/interfaces#packageowner) interface. For more information about the `deletePackageVersion` mutation, see "[`deletePackageVersion`](/graphql/reference/mutations#deletepackageversion)." diff --git a/content/packages/learn-github-packages/index.md b/content/packages/learn-github-packages/index.md index 9af151195597..cd736ad2b38c 100644 --- a/content/packages/learn-github-packages/index.md +++ b/content/packages/learn-github-packages/index.md @@ -7,9 +7,11 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} {% link_in_list /about-github-packages %} {% link_in_list /core-concepts-for-github-packages %} diff --git a/content/packages/learn-github-packages/publishing-a-package.md b/content/packages/learn-github-packages/publishing-a-package.md index 9294af45b6b9..674946386a64 100644 --- a/content/packages/learn-github-packages/publishing-a-package.md +++ b/content/packages/learn-github-packages/publishing-a-package.md @@ -9,9 +9,11 @@ permissions: Anyone with write permissions for a repository can publish a packag versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} ### About published packages @@ -25,7 +27,7 @@ If a new version of a package fixes a security vulnerability, you should publish ### Publishing a package -You can publish a package to {% data variables.product.prodname_registry %} using any {% if currentVersion == "free-pro-team@latest" %}supported package client{% else %}package type enabled for your instance{% endif %} by following the same general guidelines. +You can publish a package to {% data variables.product.prodname_registry %} using any {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" %}supported package client{% else %}package type enabled for your instance{% endif %} by following the same general guidelines. 1. Create or use an existing access token with the appropriate scopes for the task you want to accomplish. For more information, see "[About {% data variables.product.prodname_registry %}](/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages)." 2. Authenticate to {% data variables.product.prodname_registry %} using your access token and the instructions for your package client. diff --git a/content/packages/manage-packages/index.md b/content/packages/manage-packages/index.md index 21d7e0d6c36b..cfeaf4c7a6ee 100644 --- a/content/packages/manage-packages/index.md +++ b/content/packages/manage-packages/index.md @@ -9,9 +9,11 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} {% link_in_list /viewing-packages %} {% link_in_list /installing-a-package %} diff --git a/content/packages/manage-packages/installing-a-package.md b/content/packages/manage-packages/installing-a-package.md index 007e34408996..6b67f161ad95 100644 --- a/content/packages/manage-packages/installing-a-package.md +++ b/content/packages/manage-packages/installing-a-package.md @@ -9,9 +9,11 @@ permissions: Anyone with read permissions for a repository can install a package versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} ### About package installation @@ -21,7 +23,7 @@ After you find a package, you can read the package's description and installatio ### Installing a package -You can install a package from {% data variables.product.prodname_registry %} using any {% if currentVersion == "free-pro-team@latest" %}supported package client{% else %}package type enabled for your instance{% endif %} by following the same general guidelines. +You can install a package from {% data variables.product.prodname_registry %} using any {% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" %}supported package client{% else %}package type enabled for your instance{% endif %} by following the same general guidelines. 1. Authenticate to {% data variables.product.prodname_registry %} using the instructions for your package client. For more information, see "[About tokens](/packages/publishing-and-managing-packages/about-github-packages#authenticating-to-github-packages)." 2. Install the package using the instructions for your package client. diff --git a/content/packages/manage-packages/viewing-packages.md b/content/packages/manage-packages/viewing-packages.md index d61604627ea1..ee2985a3590d 100644 --- a/content/packages/manage-packages/viewing-packages.md +++ b/content/packages/manage-packages/viewing-packages.md @@ -11,9 +11,11 @@ permissions: Anyone with read permissions to a repository can view the repositor versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% data reusables.package_registry.packages-ghes-release-stage %} +{% data reusables.package_registry.packages-ghae-release-stage %} ### About package views diff --git a/content/packages/quickstart.md b/content/packages/quickstart.md index 99e96e8a87a7..cb593588cf3c 100644 --- a/content/packages/quickstart.md +++ b/content/packages/quickstart.md @@ -1,33 +1,36 @@ --- title: Quickstart for GitHub Packages -intro: 'Publish to {% data variables.product.prodname_registry %} in 5 minutes or less with {% data variables.product.prodname_actions %}.' +intro: 'Publish to {% data variables.product.prodname_registry %} with {% data variables.product.prodname_actions %}.' allowTitleToDifferFromFilename: true versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- +{% data reusables.actions.enterprise-github-hosted-runners %} +{% data reusables.actions.ae-beta %} +{% data reusables.actions.ae-self-hosted-runners-notice %} + ### Introduction -You only need an existing {% data variables.product.prodname_dotcom %} repository to publish a package to {% data variables.product.prodname_registry %}. In this guide, you'll create a {% data variables.product.prodname_actions %} workflow to test your code and then publish it to {% data variables.product.prodname_registry %}. Feel free to create a new repository for this Quickstart. You can use it to test this and future {% data variables.product.prodname_actions %} workflows. +In this guide, you'll create a {% data variables.product.prodname_actions %} workflow to test your code and then publish it to {% data variables.product.prodname_registry %}. ### Publishing your package 1. Create a new repository on {% data variables.product.prodname_dotcom %}, adding the `.gitignore` for Node. {% if currentVersion ver_lt "enterprise-server@3.1" %} Create a private repository if you’d like to delete this package later, public packages cannot be deleted.{% endif %} For more information, see "[Creating a new repository](/github/creating-cloning-and-archiving-repositories/creating-a-new-repository)." 2. Clone the repository to your local machine. - {% raw %} ```shell - $ git clone https://github.com/YOUR-USERNAME/YOUR-REPOSITORY.git + $ git clone https://{% if currentVersion == "github-ae@latest" %}YOUR-HOSTNAME{% else %}github.com{% endif %}/YOUR-USERNAME/YOUR-REPOSITORY.git $ cd YOUR-REPOSITORY ``` - {% endraw %} 3. Create an `index.js` file and add a basic alert to say "Hello world!" {% raw %} ```javascript{:copy} alert("Hello, World!"); ``` {% endraw %} -4. Initialize an npm package. In the package initialization wizard, enter your package with the name: _`@YOUR-USERNAME/YOUR-REPOSITORY`_, and set the test script to `exit 0` if you do not have any tests. Commit your changes and push them to {% data variables.product.prodname_dotcom %}. +4. Initialize an npm package with `npm init`. In the package initialization wizard, enter your package with the name: _`@YOUR-USERNAME/YOUR-REPOSITORY`_, and set the test script to `exit 0`. This will generate a `package.json` file with information about your package. {% raw %} ```shell $ npm init @@ -35,17 +38,19 @@ You only need an existing {% data variables.product.prodname_dotcom %} repositor package name: @YOUR-USERNAME/YOUR-REPOSITORY ... test command: exit 0 - ... + ... + ``` + {% endraw %} +5. Run `npm install` to generate the `package-lock.json` file, then commit and push your changes to {% data variables.product.prodname_dotcom %}. + ```shell $ npm install $ git add index.js package.json package-lock.json $ git commit -m "initialize npm package" $ git push ``` - {% endraw %} -5. From your repository on {% data variables.product.prodname_dotcom %}, create a new file in the `.github/workflows` directory named `release-package.yml`. For more information, see "[Creating new files](/github/managing-files-in-a-repository/creating-new-files)." -6. Copy the following YAML content into the `release-package.yml` file. - {% raw %} +6. Create a `.github/workflows` directory. In that directory, create a file named `release-package.yml`. +7. Copy the following YAML content into the `release-package.yml` file{% if currentVersion == "github-ae@latest" %}, replacing `YOUR-HOSTNAME` with the name of your enterprise{% endif %}. ```yaml{:copy} name: Node.js Package @@ -72,18 +77,21 @@ You only need an existing {% data variables.product.prodname_dotcom %} repositor - uses: actions/setup-node@v1 with: node-version: 12 - registry-url: https://npm.pkg.github.com/ + registry-url: {% if currentVersion == "github-ae@latest" %}https://npm.YOUR-HOSTNAME.com/{% else %}https://npm.pkg.github.com/{% endif %} - run: npm ci - run: npm publish env: - NODE_AUTH_TOKEN: ${{secrets.GITHUB_TOKEN}} + NODE_AUTH_TOKEN: ${% raw %}{{secrets.GITHUB_TOKEN}}{% endraw %} ``` - {% endraw %} -7. Scroll to the bottom of the page and select **Create a new branch for this commit and start a pull request**. Then, to create a pull request, click **Propose new file**. -8. **Merge** the pull request. -9. Navigate to the **Code** tab and create a new release to test the workflow. For more information, see "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release)." - -Creating a new release in your repository triggers the workflow to build and test your code. If the tests pass, then the package will be published to {% data variables.product.prodname_registry %}. +8. Commit and push your changes to {% data variables.product.prodname_dotcom %}. + ```shell + $ git add .github/workflows/release-package.yml + $ git commit -m "workflow to publish package" + $ git push + ``` +9. The workflow that you created will run whenever a new release is created in your repository. If the tests pass, then the package will be published to {% data variables.product.prodname_registry %}. + + To test this out, navigate to the **Code** tab in your repository and create a new release. For more information, see "[Managing releases in a repository](/github/administering-a-repository/managing-releases-in-a-repository#creating-a-release)." ### Viewing your published package diff --git a/content/rest/guides/discovering-resources-for-a-user.md b/content/rest/guides/discovering-resources-for-a-user.md index 5dec47032360..51dde9700003 100644 --- a/content/rest/guides/discovering-resources-for-a-user.md +++ b/content/rest/guides/discovering-resources-for-a-user.md @@ -22,7 +22,7 @@ If you haven't already, you should read the ["Basics of Authentication"][basics- ### Discover the repositories that your app can access for a user -In addition to having their own personal repositories, a user may be a collaborator on repositories owned by other users and organizations. Collectively, these are the repositories where the user has privileged access: either it's a private repository where the user has read or write access, or it's a public repository where the user has write access. +In addition to having their own personal repositories, a user may be a collaborator on repositories owned by other users and organizations. Collectively, these are the repositories where the user has privileged access: either it's a private repository where the user has read or write access, or it's a {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} repository where the user has write access. [OAuth scopes][scopes] and [organization application policies][oap] determine which of those repositories your app can access for a user. Use the workflow below to discover those repositories. @@ -87,11 +87,11 @@ client.organizations.each do |organization| end ``` -#### Don’t rely on public organizations +#### Return all of the user's organization memberships If you've read the docs from cover to cover, you may have noticed an [API method for listing a user's public organization memberships][list-public-orgs]. Most applications should avoid this API method. This method only returns the user's public organization memberships, not their private organization memberships. -As an application, you typically want all of the user's organizations (public and private) that your app is authorized to access. The workflow above will give you exactly that. +As an application, you typically want all of the user's organizations that your app is authorized to access. The workflow above will give you exactly that. [basics-of-authentication]: /rest/guides/basics-of-authentication [list-public-orgs]: /rest/reference/orgs#list-organizations-for-a-user diff --git a/content/rest/guides/getting-started-with-the-rest-api.md b/content/rest/guides/getting-started-with-the-rest-api.md index 3a40af9cfcc8..1313385db70d 100644 --- a/content/rest/guides/getting-started-with-the-rest-api.md +++ b/content/rest/guides/getting-started-with-the-rest-api.md @@ -155,9 +155,7 @@ $ curl -i -u your_username:your_token {% data variables.produc ``` This time, in addition to the same set of public information we -retrieved for [@defunkt][defunkt github] earlier, you should also see the non-public -information for your user profile. For example, you'll see a `plan` object -in the response which gives details about the {% data variables.product.product_name %} plan for the account. +retrieved for [@defunkt][defunkt github] earlier, you should also see the non-public information for your user profile. For example, you'll see a `plan` object in the response which gives details about the {% data variables.product.product_name %} plan for the account. #### Using OAuth tokens for apps @@ -215,8 +213,9 @@ $ curl -i {% data variables.product.api_url_pre %}/orgs/octo-org/repos The information returned from these calls will depend on which scopes our token has when we authenticate: -* A token with `public_repo` [scope][scopes] returns a response that includes all public repositories we have access to see on github.com. -* A token with `repo` [scope][scopes] returns a response that includes all public and private repositories we have access to see on github.com. +{% if currentVersion != "github-ae@latest" %} +* A token with `public_repo` [scope][scopes] returns a response that includes all public repositories we have access to see on github.com.{% endif %} +* A token with `repo` [scope][scopes] returns a response that includes all {% if currentVersion != "github-ae@latest" %}public{% else %}internal{% endif %} and private repositories we have access to see on {% data variables.product.product_location %}. As the [docs][repos-api] indicate, these methods take a `type` parameter that can filter the repositories returned based on what type of access the user has @@ -249,10 +248,8 @@ $ curl -i -H "Authorization: token 5199831f4dd3b79e7c5b7e0ebe75d67aa66e79d4" \ {% data variables.product.api_url_pre %}/user/repos ``` -In this minimal example, we create a new repository for our blog (to be served -on [GitHub Pages][pages], perhaps). Though the blog will be public, we've made -the repository private. In this single step, we'll also initialize it with -a README and a [nanoc][nanoc]-flavored [.gitignore template][gitignore templates]. +In this minimal example, we create a new private repository for our blog (to be served +on [GitHub Pages][pages], perhaps). Though the blog {% if currentVersion != "github-ae@latest" %}will be public{% else %}is accessible to all enterprise members{% endif %}, we've made the repository private. In this single step, we'll also initialize it with a README and a [nanoc][nanoc]-flavored [.gitignore template][gitignore templates]. The resulting repository will be found at `https://github.com//blog`. To create a repository under an organization for which you're diff --git a/content/rest/overview/api-previews.md b/content/rest/overview/api-previews.md index e4f5ef4da8ac..40b18ca6568a 100644 --- a/content/rest/overview/api-previews.md +++ b/content/rest/overview/api-previews.md @@ -165,7 +165,7 @@ Allows a GitHub App to run external checks on a repository's code. See the [Chec **Announced:** [2018-05-07](https://developer.github.com/changes/2018-05-07-new-checks-api-public-beta/) {% endif %} -{% if currentVersion == "github-ae@latest" or enterpriseServerVersions contains currentVersion %} +{% if currentVersion == enterpriseServerVersions contains currentVersion %} ### Anonymous Git access to repositories diff --git a/content/rest/overview/libraries.md b/content/rest/overview/libraries.md index 6222ff0c3b7b..6acee1b7fb97 100644 --- a/content/rest/overview/libraries.md +++ b/content/rest/overview/libraries.md @@ -108,6 +108,12 @@ Library name | Repository **GitHub bridge for Laravel**|[GrahamCampbell/Laravel-GitHub](https://github.com/GrahamCampbell/Laravel-GitHub) **PHP7 Client & WebHook wrapper**|[FlexyProject/GitHubAPI](https://github.com/FlexyProject/GitHubAPI) +### PowerShell + +Library name | Repository +|---|---| +**PowerShellForGitHub**|[microsoft/PowerShellForGitHub](https://github.com/microsoft/PowerShellForGitHub) + ### Python Library name | Repository diff --git a/content/rest/overview/resources-in-the-rest-api.md b/content/rest/overview/resources-in-the-rest-api.md index ef7a03c45605..e32da2a7e319 100644 --- a/content/rest/overview/resources-in-the-rest-api.md +++ b/content/rest/overview/resources-in-the-rest-api.md @@ -178,7 +178,7 @@ For `POST`, `PATCH`, `PUT`, and `DELETE` requests, parameters not included in th with a Content-Type of 'application/json': ```shell -$ curl -i -u username -d '{"scopes":["public_repo"]}' {% data variables.product.api_url_pre %}/authorizations +$ curl -i -u username -d '{"scopes":["repo_deployment"]}' {% data variables.product.api_url_pre %}/authorizations ``` ### Root endpoint diff --git a/content/rest/reference/actions.md b/content/rest/reference/actions.md index cf127e928256..507362958772 100644 --- a/content/rest/reference/actions.md +++ b/content/rest/reference/actions.md @@ -6,8 +6,11 @@ redirect_from: versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- +{% data reusables.actions.ae-beta %} + 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_app %}s require the permissions mentioned in each endpoint. For more information, see "[{% data variables.product.prodname_actions %} Documentation](/actions)." {% for operation in currentRestOperations %} @@ -16,6 +19,8 @@ The {% data variables.product.prodname_actions %} API enables you to manage {% d ## Artifacts +{% data reusables.actions.ae-beta %} + 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 %} @@ -24,9 +29,11 @@ The Artifacts API allows you to download, delete, and retrieve information about {% if operation.subcategory == 'artifacts' %}{% include rest_operation %}{% endif %} {% endfor %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} ## Permissions +{% data reusables.actions.ae-beta %} + The Permissions API allows you to set permissions for what organizations and repositories are allowed to run {% data variables.product.prodname_actions %}, and what actions are allowed to run. 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)." You can also set permissions for an enterprise. For more information, see the "[{% data variables.product.prodname_dotcom %} Enterprise administration](/rest/reference/enterprise-admin#github-actions)" REST API. @@ -38,6 +45,8 @@ You can also set permissions for an enterprise. For more information, see the "[ ## Secrets +{% data reusables.actions.ae-beta %} + 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_app %}s must have the `secrets` permission to use this API. Authenticated users must have collaborator access to a repository to create, update, or read secrets. @@ -48,6 +57,9 @@ The Secrets API lets you create, update, delete, and retrieve information about ## Self-hosted runners +{% data reusables.actions.ae-beta %} +{% data reusables.actions.ae-self-hosted-runners-notice %} + 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_app %}s must have the `administration` permission for repositories or the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to the repository or organization to use this API. @@ -60,6 +72,9 @@ You can manage self-hosted runners for an enterprise. For more information, see ## Self-hosted runner groups +{% data reusables.actions.ae-beta %} +{% data reusables.actions.ae-self-hosted-runners-notice %} + 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_app %}s must have the `administration` permission for repositories or the `organization_self_hosted_runners` permission for organizations. Authenticated users must have admin access to the repository or organization to use this API. @@ -72,6 +87,8 @@ You can manage self-hosted runner groups for an enterprise. For more information ## Workflows +{% data reusables.actions.ae-beta %} + 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 %} @@ -82,6 +99,8 @@ The Workflows API allows you to view workflows for a repository. {% data reusabl ## Workflow jobs +{% data reusables.actions.ae-beta %} + 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 %} @@ -92,6 +111,8 @@ The Workflow Jobs API allows you to view logs and workflow jobs. {% data reusabl ## Workflow runs +{% data reusables.actions.ae-beta %} + 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 %} diff --git a/content/rest/reference/code-scanning.md b/content/rest/reference/code-scanning.md index 71998e764e1a..68ae532ae503 100644 --- a/content/rest/reference/code-scanning.md +++ b/content/rest/reference/code-scanning.md @@ -6,13 +6,14 @@ product: '{% data reusables.gated-features.code-scanning %}' versions: free-pro-team: '*' enterprise-server: '>=2.22' + github-ae: '*' --- {% 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)." -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ### 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. You can use this with `GET` requests sent to the `/analyses/{analysis_id}` endpoint. 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 details about the analysis, which is 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). diff --git a/content/rest/reference/enterprise-admin.md b/content/rest/reference/enterprise-admin.md index fdeb04fecb71..f5005e0fa261 100644 --- a/content/rest/reference/enterprise-admin.md +++ b/content/rest/reference/enterprise-admin.md @@ -16,7 +16,7 @@ You can use these endpoints to administer your enterprise. {% note %} -**Note:** This article applies to {% data variables.product.prodname_ghe_cloud %}. To see the {% data variables.product.prodname_ghe_server %} version, use the **{% data ui.pages.article_version %}** drop-down menu. +**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 %} @@ -79,9 +79,11 @@ You can also read the current version by calling the [meta endpoint](/rest/refer {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} ## GitHub Actions +{% data reusables.actions.ae-beta %} + {% for operation in currentRestOperations %} {% if operation.subcategory == 'actions' %}{% include rest_operation %}{% endif %} {% endfor %} diff --git a/content/rest/reference/permissions-required-for-github-apps.md b/content/rest/reference/permissions-required-for-github-apps.md index 1aff449d4cf1..25d9b5849552 100644 --- a/content/rest/reference/permissions-required-for-github-apps.md +++ b/content/rest/reference/permissions-required-for-github-apps.md @@ -837,29 +837,29 @@ _Teams_ - [`PATCH /repos/:owner/:repo/secret-scanning/alerts/:alert_number`](/rest/reference/secret-scanning#update-a-secret-scanning-alert) (:write) {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} ### Permission on "security events" - [`GET /repos/:owner/:repo/code-scanning/alerts`](/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository) (:read) - [`GET /repos/:owner/:repo/code-scanning/alerts/:alert_number`](/rest/reference/code-scanning#get-a-code-scanning-alert) (:read) - [`PATCH /repos/:owner/:repo/code-scanning/alerts/:alert_number`](/rest/reference/code-scanning#update-a-code-scanning-alert) (:write) {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} - [`GET /repos/:owner/:repo/code-scanning/alerts/:alert_number/instances`](/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert) (:read) {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} - [`GET /repos/:owner/:repo/code-scanning/analyses`](/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository) (:read) {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} - [`GET /repos/:owner/:repo/code-scanning/analyses/:analysis_id`](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository) (:read) {% endif %} {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} - [`DELETE /repos/:owner/:repo/code-scanning/analyses/:analysis_id`](/rest/reference/code-scanning#delete-a-code-scanning-analysis-from-a-repository) (:write) {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} -- [`POST /repos/:owner/:repo/code-scanning/sarifs`](/rest/reference/code-scanning#upload-a-sarif-file) (:write) +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} +- [`POST /repos/:owner/:repo/code-scanning/sarifs`](/rest/reference/code-scanning#upload-an-analysis-as-sarif-data) (:write) {% endif %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} - [`GET /repos/:owner/:repo/code-scanning/sarifs/:sarif_id`](/rest/reference/code-scanning#get-information-about-a-sarif-upload) (:read) {% endif %} diff --git a/content/rest/reference/repos.md b/content/rest/reference/repos.md index 7233e0457f6b..b0bab1f317a7 100644 --- a/content/rest/reference/repos.md +++ b/content/rest/reference/repos.md @@ -140,7 +140,8 @@ Below is a simple sequence diagram for how these interactions would work. 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 `public_repo` and `repo` scopes grant permission to code as well. +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 {% if currentVersion != "github-ae@latest" %}`public_repo` and{% endif %}`repo` scopes grant permission to code as well. + ### Inactive deployments @@ -152,7 +153,7 @@ You can communicate that a transient environment no longer exists by setting its {% if operation.subcategory == 'deployments' %}{% include rest_operation %}{% endif %} {% endfor %} -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} ## Environments The Environments API allows you to create, configure, and delete environments. For more information about environments, see "[Environments](/actions/reference/environments)." @@ -197,7 +198,7 @@ The authenticated user will be the author of any merges done through this endpoi ## Pages -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, even though the websites are public. For more information, see "[About {% data variables.product.prodname_pages %}](/github/working-with-github-pages/about-github-pages)." +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{% if currentVersion != "github-ae@latest" %}, even if the websites are public{% endif %}. For more information, see "[About {% data variables.product.prodname_pages %}](/github/working-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. diff --git a/data/graphql/ghae/graphql_previews.ghae.yml b/data/graphql/ghae/graphql_previews.ghae.yml index 7efae641792d..7d84d7d5dad8 100644 --- a/data/graphql/ghae/graphql_previews.ghae.yml +++ b/data/graphql/ghae/graphql_previews.ghae.yml @@ -84,20 +84,6 @@ - Mutation.createContentAttachment owning_teams: - '@github/feature-lifecycle' -- title: Pinned Issues Preview - description: This preview adds support for pinned issues. - toggled_by: ':elektra-preview' - announcement: null - updates: null - toggled_on: - - Repository.pinnedIssues - - PinnedIssue - - PinnedIssueEdge - - PinnedIssueConnection - - Mutation.pinIssue - - Mutation.unpinIssue - owning_teams: - - '@github/pe-pull-requests' - title: Labels Preview description: >- This preview adds support for adding, updating, creating and deleting diff --git a/data/graphql/ghae/schema.docs-ghae.graphql b/data/graphql/ghae/schema.docs-ghae.graphql index 486eff1a56a1..6a3e96c2a1fc 100644 --- a/data/graphql/ghae/schema.docs-ghae.graphql +++ b/data/graphql/ghae/schema.docs-ghae.graphql @@ -5113,6 +5113,61 @@ type CreateDeploymentStatusPayload @preview(toggledBy: "flash-preview") { deploymentStatus: DeploymentStatus } +""" +Autogenerated input type of CreateEnterpriseOrganization +""" +input CreateEnterpriseOrganizationInput { + """ + The logins for the administrators of the new organization. + """ + adminLogins: [String!]! + + """ + The email used for sending billing receipts. + """ + billingEmail: String! + + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The ID of the enterprise owning the new organization. + """ + enterpriseId: ID! @possibleTypes(concreteTypes: ["Enterprise"]) + + """ + The login of the new organization. + """ + login: String! + + """ + The profile name of the new organization. + """ + profileName: String! +} + +""" +Autogenerated return type of CreateEnterpriseOrganization +""" +type CreateEnterpriseOrganizationPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The enterprise that owns the created organization. + """ + enterprise: Enterprise + + """ + The organization that was created. + """ + organization: Organization +} + """ Autogenerated input type of CreateIpAllowListEntry """ @@ -11259,6 +11314,11 @@ type Issue implements Assignable & Closable & Comment & Labelable & Lockable & N """ includesCreatedEdit: Boolean! + """ + Indicates whether or not this issue is currently pinned to the repository issues list + """ + isPinned: Boolean + """ Is this issue read by the viewer """ @@ -14152,577 +14212,1162 @@ type Mutation { """ Adds assignees to an assignable object. """ - addAssigneesToAssignable(input: AddAssigneesToAssignableInput!): AddAssigneesToAssignablePayload + addAssigneesToAssignable( + """ + Parameters for AddAssigneesToAssignable + """ + input: AddAssigneesToAssignableInput! + ): AddAssigneesToAssignablePayload """ Adds a comment to an Issue or Pull Request. """ - addComment(input: AddCommentInput!): AddCommentPayload + addComment( + """ + Parameters for AddComment + """ + input: AddCommentInput! + ): AddCommentPayload """ Adds an administrator to the global enterprise account. """ - addEnterpriseAdmin(input: AddEnterpriseAdminInput!): AddEnterpriseAdminPayload + addEnterpriseAdmin( + """ + Parameters for AddEnterpriseAdmin + """ + input: AddEnterpriseAdminInput! + ): AddEnterpriseAdminPayload """ Adds labels to a labelable object. """ - addLabelsToLabelable(input: AddLabelsToLabelableInput!): AddLabelsToLabelablePayload + addLabelsToLabelable( + """ + Parameters for AddLabelsToLabelable + """ + input: AddLabelsToLabelableInput! + ): AddLabelsToLabelablePayload """ Adds a card to a ProjectColumn. Either `contentId` or `note` must be provided but **not** both. """ - addProjectCard(input: AddProjectCardInput!): AddProjectCardPayload + addProjectCard( + """ + Parameters for AddProjectCard + """ + input: AddProjectCardInput! + ): AddProjectCardPayload """ Adds a column to a Project. """ - addProjectColumn(input: AddProjectColumnInput!): AddProjectColumnPayload + addProjectColumn( + """ + Parameters for AddProjectColumn + """ + input: AddProjectColumnInput! + ): AddProjectColumnPayload """ Adds a review to a Pull Request. """ - addPullRequestReview(input: AddPullRequestReviewInput!): AddPullRequestReviewPayload + addPullRequestReview( + """ + Parameters for AddPullRequestReview + """ + input: AddPullRequestReviewInput! + ): AddPullRequestReviewPayload """ Adds a comment to a review. """ - addPullRequestReviewComment(input: AddPullRequestReviewCommentInput!): AddPullRequestReviewCommentPayload + addPullRequestReviewComment( + """ + Parameters for AddPullRequestReviewComment + """ + input: AddPullRequestReviewCommentInput! + ): AddPullRequestReviewCommentPayload """ Adds a new thread to a pending Pull Request Review. """ - addPullRequestReviewThread(input: AddPullRequestReviewThreadInput!): AddPullRequestReviewThreadPayload + addPullRequestReviewThread( + """ + Parameters for AddPullRequestReviewThread + """ + input: AddPullRequestReviewThreadInput! + ): AddPullRequestReviewThreadPayload """ Adds a reaction to a subject. """ - addReaction(input: AddReactionInput!): AddReactionPayload + addReaction( + """ + Parameters for AddReaction + """ + input: AddReactionInput! + ): AddReactionPayload """ Adds a star to a Starrable. """ - addStar(input: AddStarInput!): AddStarPayload + addStar( + """ + Parameters for AddStar + """ + input: AddStarInput! + ): AddStarPayload """ Marks a repository as archived. """ - archiveRepository(input: ArchiveRepositoryInput!): ArchiveRepositoryPayload + archiveRepository( + """ + Parameters for ArchiveRepository + """ + input: ArchiveRepositoryInput! + ): ArchiveRepositoryPayload """ Update your status on GitHub. """ - changeUserStatus(input: ChangeUserStatusInput!): ChangeUserStatusPayload + changeUserStatus( + """ + Parameters for ChangeUserStatus + """ + input: ChangeUserStatusInput! + ): ChangeUserStatusPayload """ Clears all labels from a labelable object. """ - clearLabelsFromLabelable(input: ClearLabelsFromLabelableInput!): ClearLabelsFromLabelablePayload + clearLabelsFromLabelable( + """ + Parameters for ClearLabelsFromLabelable + """ + input: ClearLabelsFromLabelableInput! + ): ClearLabelsFromLabelablePayload """ Creates a new project by cloning configuration from an existing project. """ - cloneProject(input: CloneProjectInput!): CloneProjectPayload + cloneProject( + """ + Parameters for CloneProject + """ + input: CloneProjectInput! + ): CloneProjectPayload """ Create a new repository with the same files and directory structure as a template repository. """ - cloneTemplateRepository(input: CloneTemplateRepositoryInput!): CloneTemplateRepositoryPayload + cloneTemplateRepository( + """ + Parameters for CloneTemplateRepository + """ + input: CloneTemplateRepositoryInput! + ): CloneTemplateRepositoryPayload """ Close an issue. """ - closeIssue(input: CloseIssueInput!): CloseIssuePayload + closeIssue( + """ + Parameters for CloseIssue + """ + input: CloseIssueInput! + ): CloseIssuePayload """ Close a pull request. """ - closePullRequest(input: ClosePullRequestInput!): ClosePullRequestPayload + closePullRequest( + """ + Parameters for ClosePullRequest + """ + input: ClosePullRequestInput! + ): ClosePullRequestPayload """ Convert a project note card to one associated with a newly created issue. """ - convertProjectCardNoteToIssue(input: ConvertProjectCardNoteToIssueInput!): ConvertProjectCardNoteToIssuePayload + convertProjectCardNoteToIssue( + """ + Parameters for ConvertProjectCardNoteToIssue + """ + input: ConvertProjectCardNoteToIssueInput! + ): ConvertProjectCardNoteToIssuePayload """ Create a new branch protection rule """ - createBranchProtectionRule(input: CreateBranchProtectionRuleInput!): CreateBranchProtectionRulePayload + createBranchProtectionRule( + """ + Parameters for CreateBranchProtectionRule + """ + input: CreateBranchProtectionRuleInput! + ): CreateBranchProtectionRulePayload """ Create a check run. """ - createCheckRun(input: CreateCheckRunInput!): CreateCheckRunPayload + createCheckRun( + """ + Parameters for CreateCheckRun + """ + input: CreateCheckRunInput! + ): CreateCheckRunPayload """ Create a check suite """ - createCheckSuite(input: CreateCheckSuiteInput!): CreateCheckSuitePayload + createCheckSuite( + """ + Parameters for CreateCheckSuite + """ + input: CreateCheckSuiteInput! + ): CreateCheckSuitePayload """ Create a content attachment. """ - createContentAttachment(input: CreateContentAttachmentInput!): CreateContentAttachmentPayload @preview(toggledBy: "corsair-preview") + createContentAttachment( + """ + Parameters for CreateContentAttachment + """ + input: CreateContentAttachmentInput! + ): CreateContentAttachmentPayload @preview(toggledBy: "corsair-preview") """ Creates a new deployment event. """ - createDeployment(input: CreateDeploymentInput!): CreateDeploymentPayload @preview(toggledBy: "flash-preview") + createDeployment( + """ + Parameters for CreateDeployment + """ + input: CreateDeploymentInput! + ): CreateDeploymentPayload @preview(toggledBy: "flash-preview") """ Create a deployment status. """ - createDeploymentStatus(input: CreateDeploymentStatusInput!): CreateDeploymentStatusPayload @preview(toggledBy: "flash-preview") + createDeploymentStatus( + """ + Parameters for CreateDeploymentStatus + """ + input: CreateDeploymentStatusInput! + ): CreateDeploymentStatusPayload @preview(toggledBy: "flash-preview") + + """ + Creates an organization as part of an enterprise account. + """ + createEnterpriseOrganization( + """ + Parameters for CreateEnterpriseOrganization + """ + input: CreateEnterpriseOrganizationInput! + ): CreateEnterpriseOrganizationPayload """ Creates a new IP allow list entry. """ - createIpAllowListEntry(input: CreateIpAllowListEntryInput!): CreateIpAllowListEntryPayload + createIpAllowListEntry( + """ + Parameters for CreateIpAllowListEntry + """ + input: CreateIpAllowListEntryInput! + ): CreateIpAllowListEntryPayload """ Creates a new issue. """ - createIssue(input: CreateIssueInput!): CreateIssuePayload + createIssue( + """ + Parameters for CreateIssue + """ + input: CreateIssueInput! + ): CreateIssuePayload """ Creates a new label. """ - createLabel(input: CreateLabelInput!): CreateLabelPayload @preview(toggledBy: "bane-preview") + createLabel( + """ + Parameters for CreateLabel + """ + input: CreateLabelInput! + ): CreateLabelPayload @preview(toggledBy: "bane-preview") """ Creates a new project. """ - createProject(input: CreateProjectInput!): CreateProjectPayload + createProject( + """ + Parameters for CreateProject + """ + input: CreateProjectInput! + ): CreateProjectPayload """ Create a new pull request """ - createPullRequest(input: CreatePullRequestInput!): CreatePullRequestPayload + createPullRequest( + """ + Parameters for CreatePullRequest + """ + input: CreatePullRequestInput! + ): CreatePullRequestPayload """ Create a new Git Ref. """ - createRef(input: CreateRefInput!): CreateRefPayload + createRef( + """ + Parameters for CreateRef + """ + input: CreateRefInput! + ): CreateRefPayload """ Create a new repository. """ - createRepository(input: CreateRepositoryInput!): CreateRepositoryPayload + createRepository( + """ + Parameters for CreateRepository + """ + input: CreateRepositoryInput! + ): CreateRepositoryPayload """ Creates a new team discussion. """ - createTeamDiscussion(input: CreateTeamDiscussionInput!): CreateTeamDiscussionPayload + createTeamDiscussion( + """ + Parameters for CreateTeamDiscussion + """ + input: CreateTeamDiscussionInput! + ): CreateTeamDiscussionPayload """ Creates a new team discussion comment. """ - createTeamDiscussionComment(input: CreateTeamDiscussionCommentInput!): CreateTeamDiscussionCommentPayload + createTeamDiscussionComment( + """ + Parameters for CreateTeamDiscussionComment + """ + input: CreateTeamDiscussionCommentInput! + ): CreateTeamDiscussionCommentPayload """ Delete a branch protection rule """ - deleteBranchProtectionRule(input: DeleteBranchProtectionRuleInput!): DeleteBranchProtectionRulePayload + deleteBranchProtectionRule( + """ + Parameters for DeleteBranchProtectionRule + """ + input: DeleteBranchProtectionRuleInput! + ): DeleteBranchProtectionRulePayload """ Deletes a deployment. """ - deleteDeployment(input: DeleteDeploymentInput!): DeleteDeploymentPayload + deleteDeployment( + """ + Parameters for DeleteDeployment + """ + input: DeleteDeploymentInput! + ): DeleteDeploymentPayload """ Deletes an IP allow list entry. """ - deleteIpAllowListEntry(input: DeleteIpAllowListEntryInput!): DeleteIpAllowListEntryPayload + deleteIpAllowListEntry( + """ + Parameters for DeleteIpAllowListEntry + """ + input: DeleteIpAllowListEntryInput! + ): DeleteIpAllowListEntryPayload """ Deletes an Issue object. """ - deleteIssue(input: DeleteIssueInput!): DeleteIssuePayload + deleteIssue( + """ + Parameters for DeleteIssue + """ + input: DeleteIssueInput! + ): DeleteIssuePayload """ Deletes an IssueComment object. """ - deleteIssueComment(input: DeleteIssueCommentInput!): DeleteIssueCommentPayload + deleteIssueComment( + """ + Parameters for DeleteIssueComment + """ + input: DeleteIssueCommentInput! + ): DeleteIssueCommentPayload """ Deletes a label. """ - deleteLabel(input: DeleteLabelInput!): DeleteLabelPayload @preview(toggledBy: "bane-preview") + deleteLabel( + """ + Parameters for DeleteLabel + """ + input: DeleteLabelInput! + ): DeleteLabelPayload @preview(toggledBy: "bane-preview") """ Deletes a project. """ - deleteProject(input: DeleteProjectInput!): DeleteProjectPayload + deleteProject( + """ + Parameters for DeleteProject + """ + input: DeleteProjectInput! + ): DeleteProjectPayload """ Deletes a project card. """ - deleteProjectCard(input: DeleteProjectCardInput!): DeleteProjectCardPayload + deleteProjectCard( + """ + Parameters for DeleteProjectCard + """ + input: DeleteProjectCardInput! + ): DeleteProjectCardPayload """ Deletes a project column. """ - deleteProjectColumn(input: DeleteProjectColumnInput!): DeleteProjectColumnPayload + deleteProjectColumn( + """ + Parameters for DeleteProjectColumn + """ + input: DeleteProjectColumnInput! + ): DeleteProjectColumnPayload """ Deletes a pull request review. """ - deletePullRequestReview(input: DeletePullRequestReviewInput!): DeletePullRequestReviewPayload + deletePullRequestReview( + """ + Parameters for DeletePullRequestReview + """ + input: DeletePullRequestReviewInput! + ): DeletePullRequestReviewPayload """ Deletes a pull request review comment. """ - deletePullRequestReviewComment(input: DeletePullRequestReviewCommentInput!): DeletePullRequestReviewCommentPayload + deletePullRequestReviewComment( + """ + Parameters for DeletePullRequestReviewComment + """ + input: DeletePullRequestReviewCommentInput! + ): DeletePullRequestReviewCommentPayload """ Delete a Git Ref. """ - deleteRef(input: DeleteRefInput!): DeleteRefPayload + deleteRef( + """ + Parameters for DeleteRef + """ + input: DeleteRefInput! + ): DeleteRefPayload """ Deletes a team discussion. """ - deleteTeamDiscussion(input: DeleteTeamDiscussionInput!): DeleteTeamDiscussionPayload + deleteTeamDiscussion( + """ + Parameters for DeleteTeamDiscussion + """ + input: DeleteTeamDiscussionInput! + ): DeleteTeamDiscussionPayload """ Deletes a team discussion comment. """ - deleteTeamDiscussionComment(input: DeleteTeamDiscussionCommentInput!): DeleteTeamDiscussionCommentPayload + deleteTeamDiscussionComment( + """ + Parameters for DeleteTeamDiscussionComment + """ + input: DeleteTeamDiscussionCommentInput! + ): DeleteTeamDiscussionCommentPayload """ Disable auto merge on the given pull request """ - disablePullRequestAutoMerge(input: DisablePullRequestAutoMergeInput!): DisablePullRequestAutoMergePayload + disablePullRequestAutoMerge( + """ + Parameters for DisablePullRequestAutoMerge + """ + input: DisablePullRequestAutoMergeInput! + ): DisablePullRequestAutoMergePayload """ Dismisses an approved or rejected pull request review. """ - dismissPullRequestReview(input: DismissPullRequestReviewInput!): DismissPullRequestReviewPayload + dismissPullRequestReview( + """ + Parameters for DismissPullRequestReview + """ + input: DismissPullRequestReviewInput! + ): DismissPullRequestReviewPayload """ Enable the default auto-merge on a pull request. """ - enablePullRequestAutoMerge(input: EnablePullRequestAutoMergeInput!): EnablePullRequestAutoMergePayload + enablePullRequestAutoMerge( + """ + Parameters for EnablePullRequestAutoMerge + """ + input: EnablePullRequestAutoMergeInput! + ): EnablePullRequestAutoMergePayload """ Follow a user. """ - followUser(input: FollowUserInput!): FollowUserPayload + followUser( + """ + Parameters for FollowUser + """ + input: FollowUserInput! + ): FollowUserPayload """ Creates a new project by importing columns and a list of issues/PRs. """ - importProject(input: ImportProjectInput!): ImportProjectPayload @preview(toggledBy: "slothette-preview") + importProject( + """ + Parameters for ImportProject + """ + input: ImportProjectInput! + ): ImportProjectPayload @preview(toggledBy: "slothette-preview") """ Creates a repository link for a project. """ - linkRepositoryToProject(input: LinkRepositoryToProjectInput!): LinkRepositoryToProjectPayload + linkRepositoryToProject( + """ + Parameters for LinkRepositoryToProject + """ + input: LinkRepositoryToProjectInput! + ): LinkRepositoryToProjectPayload """ Lock a lockable object """ - lockLockable(input: LockLockableInput!): LockLockablePayload + lockLockable( + """ + Parameters for LockLockable + """ + input: LockLockableInput! + ): LockLockablePayload """ Mark a pull request file as viewed """ - markFileAsViewed(input: MarkFileAsViewedInput!): MarkFileAsViewedPayload + markFileAsViewed( + """ + Parameters for MarkFileAsViewed + """ + input: MarkFileAsViewedInput! + ): MarkFileAsViewedPayload """ Marks a pull request ready for review. """ - markPullRequestReadyForReview(input: MarkPullRequestReadyForReviewInput!): MarkPullRequestReadyForReviewPayload + markPullRequestReadyForReview( + """ + Parameters for MarkPullRequestReadyForReview + """ + input: MarkPullRequestReadyForReviewInput! + ): MarkPullRequestReadyForReviewPayload """ Merge a head into a branch. """ - mergeBranch(input: MergeBranchInput!): MergeBranchPayload + mergeBranch( + """ + Parameters for MergeBranch + """ + input: MergeBranchInput! + ): MergeBranchPayload """ Merge a pull request. """ - mergePullRequest(input: MergePullRequestInput!): MergePullRequestPayload + mergePullRequest( + """ + Parameters for MergePullRequest + """ + input: MergePullRequestInput! + ): MergePullRequestPayload """ Minimizes a comment on an Issue, Commit, Pull Request, or Gist """ - minimizeComment(input: MinimizeCommentInput!): MinimizeCommentPayload + minimizeComment( + """ + Parameters for MinimizeComment + """ + input: MinimizeCommentInput! + ): MinimizeCommentPayload """ Moves a project card to another place. """ - moveProjectCard(input: MoveProjectCardInput!): MoveProjectCardPayload + moveProjectCard( + """ + Parameters for MoveProjectCard + """ + input: MoveProjectCardInput! + ): MoveProjectCardPayload """ Moves a project column to another place. """ - moveProjectColumn(input: MoveProjectColumnInput!): MoveProjectColumnPayload + moveProjectColumn( + """ + Parameters for MoveProjectColumn + """ + input: MoveProjectColumnInput! + ): MoveProjectColumnPayload """ Pin an issue to a repository """ - pinIssue(input: PinIssueInput!): PinIssuePayload @preview(toggledBy: "elektra-preview") + pinIssue( + """ + Parameters for PinIssue + """ + input: PinIssueInput! + ): PinIssuePayload """ Removes assignees from an assignable object. """ - removeAssigneesFromAssignable(input: RemoveAssigneesFromAssignableInput!): RemoveAssigneesFromAssignablePayload + removeAssigneesFromAssignable( + """ + Parameters for RemoveAssigneesFromAssignable + """ + input: RemoveAssigneesFromAssignableInput! + ): RemoveAssigneesFromAssignablePayload """ Removes an administrator from the enterprise. """ - removeEnterpriseAdmin(input: RemoveEnterpriseAdminInput!): RemoveEnterpriseAdminPayload + removeEnterpriseAdmin( + """ + Parameters for RemoveEnterpriseAdmin + """ + input: RemoveEnterpriseAdminInput! + ): RemoveEnterpriseAdminPayload """ Removes labels from a Labelable object. """ - removeLabelsFromLabelable(input: RemoveLabelsFromLabelableInput!): RemoveLabelsFromLabelablePayload + removeLabelsFromLabelable( + """ + Parameters for RemoveLabelsFromLabelable + """ + input: RemoveLabelsFromLabelableInput! + ): RemoveLabelsFromLabelablePayload """ Removes outside collaborator from all repositories in an organization. """ - removeOutsideCollaborator(input: RemoveOutsideCollaboratorInput!): RemoveOutsideCollaboratorPayload + removeOutsideCollaborator( + """ + Parameters for RemoveOutsideCollaborator + """ + input: RemoveOutsideCollaboratorInput! + ): RemoveOutsideCollaboratorPayload """ Removes a reaction from a subject. """ - removeReaction(input: RemoveReactionInput!): RemoveReactionPayload + removeReaction( + """ + Parameters for RemoveReaction + """ + input: RemoveReactionInput! + ): RemoveReactionPayload """ Removes a star from a Starrable. """ - removeStar(input: RemoveStarInput!): RemoveStarPayload + removeStar( + """ + Parameters for RemoveStar + """ + input: RemoveStarInput! + ): RemoveStarPayload """ Reopen a issue. """ - reopenIssue(input: ReopenIssueInput!): ReopenIssuePayload + reopenIssue( + """ + Parameters for ReopenIssue + """ + input: ReopenIssueInput! + ): ReopenIssuePayload """ Reopen a pull request. """ - reopenPullRequest(input: ReopenPullRequestInput!): ReopenPullRequestPayload + reopenPullRequest( + """ + Parameters for ReopenPullRequest + """ + input: ReopenPullRequestInput! + ): ReopenPullRequestPayload """ Set review requests on a pull request. """ - requestReviews(input: RequestReviewsInput!): RequestReviewsPayload + requestReviews( + """ + Parameters for RequestReviews + """ + input: RequestReviewsInput! + ): RequestReviewsPayload """ Rerequests an existing check suite. """ - rerequestCheckSuite(input: RerequestCheckSuiteInput!): RerequestCheckSuitePayload + rerequestCheckSuite( + """ + Parameters for RerequestCheckSuite + """ + input: RerequestCheckSuiteInput! + ): RerequestCheckSuitePayload """ Marks a review thread as resolved. """ - resolveReviewThread(input: ResolveReviewThreadInput!): ResolveReviewThreadPayload + resolveReviewThread( + """ + Parameters for ResolveReviewThread + """ + input: ResolveReviewThreadInput! + ): ResolveReviewThreadPayload """ Submits a pending pull request review. """ - submitPullRequestReview(input: SubmitPullRequestReviewInput!): SubmitPullRequestReviewPayload + submitPullRequestReview( + """ + Parameters for SubmitPullRequestReview + """ + input: SubmitPullRequestReviewInput! + ): SubmitPullRequestReviewPayload """ Transfer an issue to a different repository """ - transferIssue(input: TransferIssueInput!): TransferIssuePayload + transferIssue( + """ + Parameters for TransferIssue + """ + input: TransferIssueInput! + ): TransferIssuePayload """ Unarchives a repository. """ - unarchiveRepository(input: UnarchiveRepositoryInput!): UnarchiveRepositoryPayload + unarchiveRepository( + """ + Parameters for UnarchiveRepository + """ + input: UnarchiveRepositoryInput! + ): UnarchiveRepositoryPayload """ Unfollow a user. """ - unfollowUser(input: UnfollowUserInput!): UnfollowUserPayload + unfollowUser( + """ + Parameters for UnfollowUser + """ + input: UnfollowUserInput! + ): UnfollowUserPayload """ Deletes a repository link from a project. """ - unlinkRepositoryFromProject(input: UnlinkRepositoryFromProjectInput!): UnlinkRepositoryFromProjectPayload + unlinkRepositoryFromProject( + """ + Parameters for UnlinkRepositoryFromProject + """ + input: UnlinkRepositoryFromProjectInput! + ): UnlinkRepositoryFromProjectPayload """ Unlock a lockable object """ - unlockLockable(input: UnlockLockableInput!): UnlockLockablePayload + unlockLockable( + """ + Parameters for UnlockLockable + """ + input: UnlockLockableInput! + ): UnlockLockablePayload """ Unmark a pull request file as viewed """ - unmarkFileAsViewed(input: UnmarkFileAsViewedInput!): UnmarkFileAsViewedPayload + unmarkFileAsViewed( + """ + Parameters for UnmarkFileAsViewed + """ + input: UnmarkFileAsViewedInput! + ): UnmarkFileAsViewedPayload """ Unmark an issue as a duplicate of another issue. """ - unmarkIssueAsDuplicate(input: UnmarkIssueAsDuplicateInput!): UnmarkIssueAsDuplicatePayload + unmarkIssueAsDuplicate( + """ + Parameters for UnmarkIssueAsDuplicate + """ + input: UnmarkIssueAsDuplicateInput! + ): UnmarkIssueAsDuplicatePayload """ Unminimizes a comment on an Issue, Commit, Pull Request, or Gist """ - unminimizeComment(input: UnminimizeCommentInput!): UnminimizeCommentPayload + unminimizeComment( + """ + Parameters for UnminimizeComment + """ + input: UnminimizeCommentInput! + ): UnminimizeCommentPayload """ Unpin a pinned issue from a repository """ - unpinIssue(input: UnpinIssueInput!): UnpinIssuePayload @preview(toggledBy: "elektra-preview") + unpinIssue( + """ + Parameters for UnpinIssue + """ + input: UnpinIssueInput! + ): UnpinIssuePayload """ Marks a review thread as unresolved. """ - unresolveReviewThread(input: UnresolveReviewThreadInput!): UnresolveReviewThreadPayload + unresolveReviewThread( + """ + Parameters for UnresolveReviewThread + """ + input: UnresolveReviewThreadInput! + ): UnresolveReviewThreadPayload """ Create a new branch protection rule """ - updateBranchProtectionRule(input: UpdateBranchProtectionRuleInput!): UpdateBranchProtectionRulePayload + updateBranchProtectionRule( + """ + Parameters for UpdateBranchProtectionRule + """ + input: UpdateBranchProtectionRuleInput! + ): UpdateBranchProtectionRulePayload """ Update a check run """ - updateCheckRun(input: UpdateCheckRunInput!): UpdateCheckRunPayload + updateCheckRun( + """ + Parameters for UpdateCheckRun + """ + input: UpdateCheckRunInput! + ): UpdateCheckRunPayload """ Modifies the settings of an existing check suite """ - updateCheckSuitePreferences(input: UpdateCheckSuitePreferencesInput!): UpdateCheckSuitePreferencesPayload + updateCheckSuitePreferences( + """ + Parameters for UpdateCheckSuitePreferences + """ + input: UpdateCheckSuitePreferencesInput! + ): UpdateCheckSuitePreferencesPayload """ Sets whether private repository forks are enabled for an enterprise. """ - updateEnterpriseAllowPrivateRepositoryForkingSetting(input: UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput!): UpdateEnterpriseAllowPrivateRepositoryForkingSettingPayload + updateEnterpriseAllowPrivateRepositoryForkingSetting( + """ + Parameters for UpdateEnterpriseAllowPrivateRepositoryForkingSetting + """ + input: UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput! + ): UpdateEnterpriseAllowPrivateRepositoryForkingSettingPayload """ Sets the default repository permission for organizations in an enterprise. """ - updateEnterpriseDefaultRepositoryPermissionSetting(input: UpdateEnterpriseDefaultRepositoryPermissionSettingInput!): UpdateEnterpriseDefaultRepositoryPermissionSettingPayload + updateEnterpriseDefaultRepositoryPermissionSetting( + """ + Parameters for UpdateEnterpriseDefaultRepositoryPermissionSetting + """ + input: UpdateEnterpriseDefaultRepositoryPermissionSettingInput! + ): UpdateEnterpriseDefaultRepositoryPermissionSettingPayload """ Sets whether organization members with admin permissions on a repository can change repository visibility. """ - updateEnterpriseMembersCanChangeRepositoryVisibilitySetting(input: UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput!): UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingPayload + updateEnterpriseMembersCanChangeRepositoryVisibilitySetting( + """ + Parameters for UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting + """ + input: UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput! + ): UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingPayload """ Sets the members can create repositories setting for an enterprise. """ - updateEnterpriseMembersCanCreateRepositoriesSetting(input: UpdateEnterpriseMembersCanCreateRepositoriesSettingInput!): UpdateEnterpriseMembersCanCreateRepositoriesSettingPayload + updateEnterpriseMembersCanCreateRepositoriesSetting( + """ + Parameters for UpdateEnterpriseMembersCanCreateRepositoriesSetting + """ + input: UpdateEnterpriseMembersCanCreateRepositoriesSettingInput! + ): UpdateEnterpriseMembersCanCreateRepositoriesSettingPayload """ Sets the members can delete issues setting for an enterprise. """ - updateEnterpriseMembersCanDeleteIssuesSetting(input: UpdateEnterpriseMembersCanDeleteIssuesSettingInput!): UpdateEnterpriseMembersCanDeleteIssuesSettingPayload + updateEnterpriseMembersCanDeleteIssuesSetting( + """ + Parameters for UpdateEnterpriseMembersCanDeleteIssuesSetting + """ + input: UpdateEnterpriseMembersCanDeleteIssuesSettingInput! + ): UpdateEnterpriseMembersCanDeleteIssuesSettingPayload """ Sets the members can delete repositories setting for an enterprise. """ - updateEnterpriseMembersCanDeleteRepositoriesSetting(input: UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput!): UpdateEnterpriseMembersCanDeleteRepositoriesSettingPayload + updateEnterpriseMembersCanDeleteRepositoriesSetting( + """ + Parameters for UpdateEnterpriseMembersCanDeleteRepositoriesSetting + """ + input: UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput! + ): UpdateEnterpriseMembersCanDeleteRepositoriesSettingPayload """ Sets whether members can invite collaborators are enabled for an enterprise. """ - updateEnterpriseMembersCanInviteCollaboratorsSetting(input: UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput!): UpdateEnterpriseMembersCanInviteCollaboratorsSettingPayload + updateEnterpriseMembersCanInviteCollaboratorsSetting( + """ + Parameters for UpdateEnterpriseMembersCanInviteCollaboratorsSetting + """ + input: UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput! + ): UpdateEnterpriseMembersCanInviteCollaboratorsSettingPayload """ Sets whether or not an organization admin can make purchases. """ - updateEnterpriseMembersCanMakePurchasesSetting(input: UpdateEnterpriseMembersCanMakePurchasesSettingInput!): UpdateEnterpriseMembersCanMakePurchasesSettingPayload + updateEnterpriseMembersCanMakePurchasesSetting( + """ + Parameters for UpdateEnterpriseMembersCanMakePurchasesSetting + """ + input: UpdateEnterpriseMembersCanMakePurchasesSettingInput! + ): UpdateEnterpriseMembersCanMakePurchasesSettingPayload """ Sets the members can update protected branches setting for an enterprise. """ - updateEnterpriseMembersCanUpdateProtectedBranchesSetting(input: UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput!): UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingPayload + updateEnterpriseMembersCanUpdateProtectedBranchesSetting( + """ + Parameters for UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting + """ + input: UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput! + ): UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingPayload """ Sets the members can view dependency insights for an enterprise. """ - updateEnterpriseMembersCanViewDependencyInsightsSetting(input: UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput!): UpdateEnterpriseMembersCanViewDependencyInsightsSettingPayload + updateEnterpriseMembersCanViewDependencyInsightsSetting( + """ + Parameters for UpdateEnterpriseMembersCanViewDependencyInsightsSetting + """ + input: UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput! + ): UpdateEnterpriseMembersCanViewDependencyInsightsSettingPayload """ Sets whether organization projects are enabled for an enterprise. """ - updateEnterpriseOrganizationProjectsSetting(input: UpdateEnterpriseOrganizationProjectsSettingInput!): UpdateEnterpriseOrganizationProjectsSettingPayload + updateEnterpriseOrganizationProjectsSetting( + """ + Parameters for UpdateEnterpriseOrganizationProjectsSetting + """ + input: UpdateEnterpriseOrganizationProjectsSettingInput! + ): UpdateEnterpriseOrganizationProjectsSettingPayload """ Updates an enterprise's profile. """ - updateEnterpriseProfile(input: UpdateEnterpriseProfileInput!): UpdateEnterpriseProfilePayload + updateEnterpriseProfile( + """ + Parameters for UpdateEnterpriseProfile + """ + input: UpdateEnterpriseProfileInput! + ): UpdateEnterpriseProfilePayload """ Sets whether repository projects are enabled for a enterprise. """ - updateEnterpriseRepositoryProjectsSetting(input: UpdateEnterpriseRepositoryProjectsSettingInput!): UpdateEnterpriseRepositoryProjectsSettingPayload + updateEnterpriseRepositoryProjectsSetting( + """ + Parameters for UpdateEnterpriseRepositoryProjectsSetting + """ + input: UpdateEnterpriseRepositoryProjectsSettingInput! + ): UpdateEnterpriseRepositoryProjectsSettingPayload """ Sets whether team discussions are enabled for an enterprise. """ - updateEnterpriseTeamDiscussionsSetting(input: UpdateEnterpriseTeamDiscussionsSettingInput!): UpdateEnterpriseTeamDiscussionsSettingPayload + updateEnterpriseTeamDiscussionsSetting( + """ + Parameters for UpdateEnterpriseTeamDiscussionsSetting + """ + input: UpdateEnterpriseTeamDiscussionsSettingInput! + ): UpdateEnterpriseTeamDiscussionsSettingPayload """ Sets whether two factor authentication is required for all users in an enterprise. """ - updateEnterpriseTwoFactorAuthenticationRequiredSetting(input: UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput!): UpdateEnterpriseTwoFactorAuthenticationRequiredSettingPayload + updateEnterpriseTwoFactorAuthenticationRequiredSetting( + """ + Parameters for UpdateEnterpriseTwoFactorAuthenticationRequiredSetting + """ + input: UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput! + ): UpdateEnterpriseTwoFactorAuthenticationRequiredSettingPayload """ Sets whether an IP allow list is enabled on an owner. """ - updateIpAllowListEnabledSetting(input: UpdateIpAllowListEnabledSettingInput!): UpdateIpAllowListEnabledSettingPayload + updateIpAllowListEnabledSetting( + """ + Parameters for UpdateIpAllowListEnabledSetting + """ + input: UpdateIpAllowListEnabledSettingInput! + ): UpdateIpAllowListEnabledSettingPayload """ Updates an IP allow list entry. """ - updateIpAllowListEntry(input: UpdateIpAllowListEntryInput!): UpdateIpAllowListEntryPayload + updateIpAllowListEntry( + """ + Parameters for UpdateIpAllowListEntry + """ + input: UpdateIpAllowListEntryInput! + ): UpdateIpAllowListEntryPayload """ Updates an Issue. """ - updateIssue(input: UpdateIssueInput!): UpdateIssuePayload + updateIssue( + """ + Parameters for UpdateIssue + """ + input: UpdateIssueInput! + ): UpdateIssuePayload """ Updates an IssueComment object. """ - updateIssueComment(input: UpdateIssueCommentInput!): UpdateIssueCommentPayload + updateIssueComment( + """ + Parameters for UpdateIssueComment + """ + input: UpdateIssueCommentInput! + ): UpdateIssueCommentPayload """ Updates an existing label. """ - updateLabel(input: UpdateLabelInput!): UpdateLabelPayload @preview(toggledBy: "bane-preview") + updateLabel( + """ + Parameters for UpdateLabel + """ + input: UpdateLabelInput! + ): UpdateLabelPayload @preview(toggledBy: "bane-preview") """ Updates an existing project. """ - updateProject(input: UpdateProjectInput!): UpdateProjectPayload + updateProject( + """ + Parameters for UpdateProject + """ + input: UpdateProjectInput! + ): UpdateProjectPayload """ Updates an existing project card. """ - updateProjectCard(input: UpdateProjectCardInput!): UpdateProjectCardPayload + updateProjectCard( + """ + Parameters for UpdateProjectCard + """ + input: UpdateProjectCardInput! + ): UpdateProjectCardPayload """ Updates an existing project column. """ - updateProjectColumn(input: UpdateProjectColumnInput!): UpdateProjectColumnPayload + updateProjectColumn( + """ + Parameters for UpdateProjectColumn + """ + input: UpdateProjectColumnInput! + ): UpdateProjectColumnPayload """ Update a pull request """ - updatePullRequest(input: UpdatePullRequestInput!): UpdatePullRequestPayload + updatePullRequest( + """ + Parameters for UpdatePullRequest + """ + input: UpdatePullRequestInput! + ): UpdatePullRequestPayload """ Updates the body of a pull request review. """ - updatePullRequestReview(input: UpdatePullRequestReviewInput!): UpdatePullRequestReviewPayload + updatePullRequestReview( + """ + Parameters for UpdatePullRequestReview + """ + input: UpdatePullRequestReviewInput! + ): UpdatePullRequestReviewPayload """ Updates a pull request review comment. """ - updatePullRequestReviewComment(input: UpdatePullRequestReviewCommentInput!): UpdatePullRequestReviewCommentPayload + updatePullRequestReviewComment( + """ + Parameters for UpdatePullRequestReviewComment + """ + input: UpdatePullRequestReviewCommentInput! + ): UpdatePullRequestReviewCommentPayload """ Update a Git Ref. """ - updateRef(input: UpdateRefInput!): UpdateRefPayload + updateRef( + """ + Parameters for UpdateRef + """ + input: UpdateRefInput! + ): UpdateRefPayload """ Creates, updates and/or deletes multiple refs in a repository. @@ -14744,37 +15389,72 @@ type Mutation { If `RefUpdate.force` is set to `true`, a non-fast-forward updates for the given reference will be allowed. """ - updateRefs(input: UpdateRefsInput!): UpdateRefsPayload @preview(toggledBy: "update-refs-preview") + updateRefs( + """ + Parameters for UpdateRefs + """ + input: UpdateRefsInput! + ): UpdateRefsPayload @preview(toggledBy: "update-refs-preview") """ Update information about a repository. """ - updateRepository(input: UpdateRepositoryInput!): UpdateRepositoryPayload + updateRepository( + """ + Parameters for UpdateRepository + """ + input: UpdateRepositoryInput! + ): UpdateRepositoryPayload """ Updates the state for subscribable subjects. """ - updateSubscription(input: UpdateSubscriptionInput!): UpdateSubscriptionPayload + updateSubscription( + """ + Parameters for UpdateSubscription + """ + input: UpdateSubscriptionInput! + ): UpdateSubscriptionPayload """ Updates a team discussion. """ - updateTeamDiscussion(input: UpdateTeamDiscussionInput!): UpdateTeamDiscussionPayload + updateTeamDiscussion( + """ + Parameters for UpdateTeamDiscussion + """ + input: UpdateTeamDiscussionInput! + ): UpdateTeamDiscussionPayload """ Updates a discussion comment. """ - updateTeamDiscussionComment(input: UpdateTeamDiscussionCommentInput!): UpdateTeamDiscussionCommentPayload + updateTeamDiscussionComment( + """ + Parameters for UpdateTeamDiscussionComment + """ + input: UpdateTeamDiscussionCommentInput! + ): UpdateTeamDiscussionCommentPayload """ Updates team review assignment. """ - updateTeamReviewAssignment(input: UpdateTeamReviewAssignmentInput!): UpdateTeamReviewAssignmentPayload @preview(toggledBy: "stone-crop-preview") + updateTeamReviewAssignment( + """ + Parameters for UpdateTeamReviewAssignment + """ + input: UpdateTeamReviewAssignmentInput! + ): UpdateTeamReviewAssignmentPayload @preview(toggledBy: "stone-crop-preview") """ Replaces the repository's topics with the given topics. """ - updateTopics(input: UpdateTopicsInput!): UpdateTopicsPayload + updateTopics( + """ + Parameters for UpdateTopics + """ + input: UpdateTopicsInput! + ): UpdateTopicsPayload } """ @@ -19318,7 +19998,7 @@ type PinnedEvent implements Node { """ A Pinned Issue is a issue pinned to a repository's index page. """ -type PinnedIssue implements Node @preview(toggledBy: "elektra-preview") { +type PinnedIssue implements Node { """ Identifies the primary key from the database. """ @@ -19344,7 +20024,7 @@ type PinnedIssue implements Node @preview(toggledBy: "elektra-preview") { """ The connection type for PinnedIssue. """ -type PinnedIssueConnection @preview(toggledBy: "elektra-preview") { +type PinnedIssueConnection { """ A list of edges. """ @@ -19369,7 +20049,7 @@ type PinnedIssueConnection @preview(toggledBy: "elektra-preview") { """ An edge in a connection. """ -type PinnedIssueEdge @preview(toggledBy: "elektra-preview") { +type PinnedIssueEdge { """ A cursor for use in pagination. """ @@ -24178,6 +24858,11 @@ type Release implements Node & UniformResourceLocatable { """ tag: Ref + """ + The tag commit for this release. + """ + tagCommit: Commit + """ The name of the release's Git tag """ @@ -27759,7 +28444,7 @@ type Repository implements Node & ProjectOwner & RepositoryInfo & Starrable & Su Returns the last _n_ elements from the list. """ last: Int - ): PinnedIssueConnection @preview(toggledBy: "elektra-preview") + ): PinnedIssueConnection """ The primary language of the repository's code. @@ -35966,6 +36651,11 @@ type User implements Actor & Node & ProfileOwner & ProjectOwner & RepositoryOwne """ isEmployee: Boolean! + """ + Whether or not this user is a member of the GitHub Stars Program. + """ + isGitHubStar: Boolean! + """ Whether or not the user has marked themselves as for hire. """ @@ -37040,6 +37730,11 @@ enum UserStatusOrderField { A domain that can be verified for an organization or an enterprise. """ type VerifiableDomain implements Node { + """ + Identifies the date and time when the object was created. + """ + createdAt: DateTime! + """ Identifies the primary key from the database. """ @@ -37091,6 +37786,11 @@ type VerifiableDomain implements Node { """ tokenExpirationTime: DateTime + """ + Identifies the date and time when the object was last updated. + """ + updatedAt: DateTime! + """ The current verification token for the domain. """ diff --git a/data/graphql/graphql_previews.yml b/data/graphql/graphql_previews.yml index 2250a53638ad..181b6839c01f 100644 --- a/data/graphql/graphql_previews.yml +++ b/data/graphql/graphql_previews.yml @@ -100,20 +100,6 @@ - Mutation.createContentAttachment owning_teams: - '@github/feature-lifecycle' -- title: Pinned Issues Preview - description: This preview adds support for pinned issues. - toggled_by: ':elektra-preview' - announcement: null - updates: null - toggled_on: - - Repository.pinnedIssues - - PinnedIssue - - PinnedIssueEdge - - PinnedIssueConnection - - Mutation.pinIssue - - Mutation.unpinIssue - owning_teams: - - '@github/pe-pull-requests' - title: Labels Preview description: >- This preview adds support for adding, updating, creating and deleting diff --git a/data/graphql/schema.docs.graphql b/data/graphql/schema.docs.graphql index 906aa62d6d9a..c83afc924933 100644 --- a/data/graphql/schema.docs.graphql +++ b/data/graphql/schema.docs.graphql @@ -775,6 +775,36 @@ type App implements Node { url: URI! } +""" +Autogenerated input type of ApproveVerifiableDomain +""" +input ApproveVerifiableDomainInput { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The ID of the verifiable domain to approve. + """ + id: ID! @possibleTypes(concreteTypes: ["VerifiableDomain"]) +} + +""" +Autogenerated return type of ApproveVerifiableDomain +""" +type ApproveVerifiableDomainPayload { + """ + A unique identifier for the client performing the mutation. + """ + clientMutationId: String + + """ + The verifiable domain that was approved. + """ + domain: VerifiableDomain +} + """ Autogenerated input type of ArchiveRepository """ @@ -8673,7 +8703,7 @@ type EnterpriseOwnerInfo { """ Filter whether or not the domain is verified. """ - isVerified: Boolean + isVerified: Boolean = null """ Returns the last _n_ elements from the list. @@ -12025,6 +12055,11 @@ type Issue implements Assignable & Closable & Comment & Labelable & Lockable & N """ includesCreatedEdit: Boolean! + """ + Indicates whether or not this issue is currently pinned to the repository issues list + """ + isPinned: Boolean + """ Is this issue read by the viewer """ @@ -15302,677 +15337,1362 @@ type Mutation { """ Accepts a pending invitation for a user to become an administrator of an enterprise. """ - acceptEnterpriseAdministratorInvitation(input: AcceptEnterpriseAdministratorInvitationInput!): AcceptEnterpriseAdministratorInvitationPayload + acceptEnterpriseAdministratorInvitation( + """ + Parameters for AcceptEnterpriseAdministratorInvitation + """ + input: AcceptEnterpriseAdministratorInvitationInput! + ): AcceptEnterpriseAdministratorInvitationPayload """ Applies a suggested topic to the repository. """ - acceptTopicSuggestion(input: AcceptTopicSuggestionInput!): AcceptTopicSuggestionPayload + acceptTopicSuggestion( + """ + Parameters for AcceptTopicSuggestion + """ + input: AcceptTopicSuggestionInput! + ): AcceptTopicSuggestionPayload """ Adds assignees to an assignable object. """ - addAssigneesToAssignable(input: AddAssigneesToAssignableInput!): AddAssigneesToAssignablePayload + addAssigneesToAssignable( + """ + Parameters for AddAssigneesToAssignable + """ + input: AddAssigneesToAssignableInput! + ): AddAssigneesToAssignablePayload """ Adds a comment to an Issue or Pull Request. """ - addComment(input: AddCommentInput!): AddCommentPayload + addComment( + """ + Parameters for AddComment + """ + input: AddCommentInput! + ): AddCommentPayload """ Adds a support entitlement to an enterprise member. """ - addEnterpriseSupportEntitlement(input: AddEnterpriseSupportEntitlementInput!): AddEnterpriseSupportEntitlementPayload + addEnterpriseSupportEntitlement( + """ + Parameters for AddEnterpriseSupportEntitlement + """ + input: AddEnterpriseSupportEntitlementInput! + ): AddEnterpriseSupportEntitlementPayload """ Adds labels to a labelable object. """ - addLabelsToLabelable(input: AddLabelsToLabelableInput!): AddLabelsToLabelablePayload + addLabelsToLabelable( + """ + Parameters for AddLabelsToLabelable + """ + input: AddLabelsToLabelableInput! + ): AddLabelsToLabelablePayload """ Adds a card to a ProjectColumn. Either `contentId` or `note` must be provided but **not** both. """ - addProjectCard(input: AddProjectCardInput!): AddProjectCardPayload + addProjectCard( + """ + Parameters for AddProjectCard + """ + input: AddProjectCardInput! + ): AddProjectCardPayload """ Adds a column to a Project. """ - addProjectColumn(input: AddProjectColumnInput!): AddProjectColumnPayload + addProjectColumn( + """ + Parameters for AddProjectColumn + """ + input: AddProjectColumnInput! + ): AddProjectColumnPayload """ Adds a review to a Pull Request. """ - addPullRequestReview(input: AddPullRequestReviewInput!): AddPullRequestReviewPayload + addPullRequestReview( + """ + Parameters for AddPullRequestReview + """ + input: AddPullRequestReviewInput! + ): AddPullRequestReviewPayload """ Adds a comment to a review. """ - addPullRequestReviewComment(input: AddPullRequestReviewCommentInput!): AddPullRequestReviewCommentPayload + addPullRequestReviewComment( + """ + Parameters for AddPullRequestReviewComment + """ + input: AddPullRequestReviewCommentInput! + ): AddPullRequestReviewCommentPayload """ Adds a new thread to a pending Pull Request Review. """ - addPullRequestReviewThread(input: AddPullRequestReviewThreadInput!): AddPullRequestReviewThreadPayload + addPullRequestReviewThread( + """ + Parameters for AddPullRequestReviewThread + """ + input: AddPullRequestReviewThreadInput! + ): AddPullRequestReviewThreadPayload """ Adds a reaction to a subject. """ - addReaction(input: AddReactionInput!): AddReactionPayload + addReaction( + """ + Parameters for AddReaction + """ + input: AddReactionInput! + ): AddReactionPayload """ Adds a star to a Starrable. """ - addStar(input: AddStarInput!): AddStarPayload + addStar( + """ + Parameters for AddStar + """ + input: AddStarInput! + ): AddStarPayload """ Adds a verifiable domain to an owning account. """ - addVerifiableDomain(input: AddVerifiableDomainInput!): AddVerifiableDomainPayload + addVerifiableDomain( + """ + Parameters for AddVerifiableDomain + """ + input: AddVerifiableDomainInput! + ): AddVerifiableDomainPayload + + """ + Approve a verifiable domain for notification delivery. + """ + approveVerifiableDomain( + """ + Parameters for ApproveVerifiableDomain + """ + input: ApproveVerifiableDomainInput! + ): ApproveVerifiableDomainPayload """ Marks a repository as archived. """ - archiveRepository(input: ArchiveRepositoryInput!): ArchiveRepositoryPayload + archiveRepository( + """ + Parameters for ArchiveRepository + """ + input: ArchiveRepositoryInput! + ): ArchiveRepositoryPayload """ Cancels a pending invitation for an administrator to join an enterprise. """ - cancelEnterpriseAdminInvitation(input: CancelEnterpriseAdminInvitationInput!): CancelEnterpriseAdminInvitationPayload + cancelEnterpriseAdminInvitation( + """ + Parameters for CancelEnterpriseAdminInvitation + """ + input: CancelEnterpriseAdminInvitationInput! + ): CancelEnterpriseAdminInvitationPayload """ Update your status on GitHub. """ - changeUserStatus(input: ChangeUserStatusInput!): ChangeUserStatusPayload + changeUserStatus( + """ + Parameters for ChangeUserStatus + """ + input: ChangeUserStatusInput! + ): ChangeUserStatusPayload """ Clears all labels from a labelable object. """ - clearLabelsFromLabelable(input: ClearLabelsFromLabelableInput!): ClearLabelsFromLabelablePayload + clearLabelsFromLabelable( + """ + Parameters for ClearLabelsFromLabelable + """ + input: ClearLabelsFromLabelableInput! + ): ClearLabelsFromLabelablePayload """ Creates a new project by cloning configuration from an existing project. """ - cloneProject(input: CloneProjectInput!): CloneProjectPayload + cloneProject( + """ + Parameters for CloneProject + """ + input: CloneProjectInput! + ): CloneProjectPayload """ Create a new repository with the same files and directory structure as a template repository. """ - cloneTemplateRepository(input: CloneTemplateRepositoryInput!): CloneTemplateRepositoryPayload + cloneTemplateRepository( + """ + Parameters for CloneTemplateRepository + """ + input: CloneTemplateRepositoryInput! + ): CloneTemplateRepositoryPayload """ Close an issue. """ - closeIssue(input: CloseIssueInput!): CloseIssuePayload + closeIssue( + """ + Parameters for CloseIssue + """ + input: CloseIssueInput! + ): CloseIssuePayload """ Close a pull request. """ - closePullRequest(input: ClosePullRequestInput!): ClosePullRequestPayload + closePullRequest( + """ + Parameters for ClosePullRequest + """ + input: ClosePullRequestInput! + ): ClosePullRequestPayload """ Convert a project note card to one associated with a newly created issue. """ - convertProjectCardNoteToIssue(input: ConvertProjectCardNoteToIssueInput!): ConvertProjectCardNoteToIssuePayload + convertProjectCardNoteToIssue( + """ + Parameters for ConvertProjectCardNoteToIssue + """ + input: ConvertProjectCardNoteToIssueInput! + ): ConvertProjectCardNoteToIssuePayload """ Create a new branch protection rule """ - createBranchProtectionRule(input: CreateBranchProtectionRuleInput!): CreateBranchProtectionRulePayload + createBranchProtectionRule( + """ + Parameters for CreateBranchProtectionRule + """ + input: CreateBranchProtectionRuleInput! + ): CreateBranchProtectionRulePayload """ Create a check run. """ - createCheckRun(input: CreateCheckRunInput!): CreateCheckRunPayload + createCheckRun( + """ + Parameters for CreateCheckRun + """ + input: CreateCheckRunInput! + ): CreateCheckRunPayload """ Create a check suite """ - createCheckSuite(input: CreateCheckSuiteInput!): CreateCheckSuitePayload + createCheckSuite( + """ + Parameters for CreateCheckSuite + """ + input: CreateCheckSuiteInput! + ): CreateCheckSuitePayload """ Create a content attachment. """ - createContentAttachment(input: CreateContentAttachmentInput!): CreateContentAttachmentPayload @preview(toggledBy: "corsair-preview") + createContentAttachment( + """ + Parameters for CreateContentAttachment + """ + input: CreateContentAttachmentInput! + ): CreateContentAttachmentPayload @preview(toggledBy: "corsair-preview") """ Creates a new deployment event. """ - createDeployment(input: CreateDeploymentInput!): CreateDeploymentPayload @preview(toggledBy: "flash-preview") + createDeployment( + """ + Parameters for CreateDeployment + """ + input: CreateDeploymentInput! + ): CreateDeploymentPayload @preview(toggledBy: "flash-preview") """ Create a deployment status. """ - createDeploymentStatus(input: CreateDeploymentStatusInput!): CreateDeploymentStatusPayload @preview(toggledBy: "flash-preview") + createDeploymentStatus( + """ + Parameters for CreateDeploymentStatus + """ + input: CreateDeploymentStatusInput! + ): CreateDeploymentStatusPayload @preview(toggledBy: "flash-preview") """ Creates an organization as part of an enterprise account. """ - createEnterpriseOrganization(input: CreateEnterpriseOrganizationInput!): CreateEnterpriseOrganizationPayload + createEnterpriseOrganization( + """ + Parameters for CreateEnterpriseOrganization + """ + input: CreateEnterpriseOrganizationInput! + ): CreateEnterpriseOrganizationPayload """ Creates a new IP allow list entry. """ - createIpAllowListEntry(input: CreateIpAllowListEntryInput!): CreateIpAllowListEntryPayload + createIpAllowListEntry( + """ + Parameters for CreateIpAllowListEntry + """ + input: CreateIpAllowListEntryInput! + ): CreateIpAllowListEntryPayload """ Creates a new issue. """ - createIssue(input: CreateIssueInput!): CreateIssuePayload + createIssue( + """ + Parameters for CreateIssue + """ + input: CreateIssueInput! + ): CreateIssuePayload """ Creates a new label. """ - createLabel(input: CreateLabelInput!): CreateLabelPayload @preview(toggledBy: "bane-preview") + createLabel( + """ + Parameters for CreateLabel + """ + input: CreateLabelInput! + ): CreateLabelPayload @preview(toggledBy: "bane-preview") """ Creates a new project. """ - createProject(input: CreateProjectInput!): CreateProjectPayload + createProject( + """ + Parameters for CreateProject + """ + input: CreateProjectInput! + ): CreateProjectPayload """ Create a new pull request """ - createPullRequest(input: CreatePullRequestInput!): CreatePullRequestPayload + createPullRequest( + """ + Parameters for CreatePullRequest + """ + input: CreatePullRequestInput! + ): CreatePullRequestPayload """ Create a new Git Ref. """ - createRef(input: CreateRefInput!): CreateRefPayload + createRef( + """ + Parameters for CreateRef + """ + input: CreateRefInput! + ): CreateRefPayload """ Create a new repository. """ - createRepository(input: CreateRepositoryInput!): CreateRepositoryPayload + createRepository( + """ + Parameters for CreateRepository + """ + input: CreateRepositoryInput! + ): CreateRepositoryPayload """ Creates a new team discussion. """ - createTeamDiscussion(input: CreateTeamDiscussionInput!): CreateTeamDiscussionPayload + createTeamDiscussion( + """ + Parameters for CreateTeamDiscussion + """ + input: CreateTeamDiscussionInput! + ): CreateTeamDiscussionPayload """ Creates a new team discussion comment. """ - createTeamDiscussionComment(input: CreateTeamDiscussionCommentInput!): CreateTeamDiscussionCommentPayload + createTeamDiscussionComment( + """ + Parameters for CreateTeamDiscussionComment + """ + input: CreateTeamDiscussionCommentInput! + ): CreateTeamDiscussionCommentPayload """ Rejects a suggested topic for the repository. """ - declineTopicSuggestion(input: DeclineTopicSuggestionInput!): DeclineTopicSuggestionPayload + declineTopicSuggestion( + """ + Parameters for DeclineTopicSuggestion + """ + input: DeclineTopicSuggestionInput! + ): DeclineTopicSuggestionPayload """ Delete a branch protection rule """ - deleteBranchProtectionRule(input: DeleteBranchProtectionRuleInput!): DeleteBranchProtectionRulePayload + deleteBranchProtectionRule( + """ + Parameters for DeleteBranchProtectionRule + """ + input: DeleteBranchProtectionRuleInput! + ): DeleteBranchProtectionRulePayload """ Deletes a deployment. """ - deleteDeployment(input: DeleteDeploymentInput!): DeleteDeploymentPayload + deleteDeployment( + """ + Parameters for DeleteDeployment + """ + input: DeleteDeploymentInput! + ): DeleteDeploymentPayload """ Deletes an IP allow list entry. """ - deleteIpAllowListEntry(input: DeleteIpAllowListEntryInput!): DeleteIpAllowListEntryPayload + deleteIpAllowListEntry( + """ + Parameters for DeleteIpAllowListEntry + """ + input: DeleteIpAllowListEntryInput! + ): DeleteIpAllowListEntryPayload """ Deletes an Issue object. """ - deleteIssue(input: DeleteIssueInput!): DeleteIssuePayload + deleteIssue( + """ + Parameters for DeleteIssue + """ + input: DeleteIssueInput! + ): DeleteIssuePayload """ Deletes an IssueComment object. """ - deleteIssueComment(input: DeleteIssueCommentInput!): DeleteIssueCommentPayload + deleteIssueComment( + """ + Parameters for DeleteIssueComment + """ + input: DeleteIssueCommentInput! + ): DeleteIssueCommentPayload """ Deletes a label. """ - deleteLabel(input: DeleteLabelInput!): DeleteLabelPayload @preview(toggledBy: "bane-preview") + deleteLabel( + """ + Parameters for DeleteLabel + """ + input: DeleteLabelInput! + ): DeleteLabelPayload @preview(toggledBy: "bane-preview") """ Delete a package version. """ - deletePackageVersion(input: DeletePackageVersionInput!): DeletePackageVersionPayload @preview(toggledBy: "package-deletes-preview") + deletePackageVersion( + """ + Parameters for DeletePackageVersion + """ + input: DeletePackageVersionInput! + ): DeletePackageVersionPayload @preview(toggledBy: "package-deletes-preview") """ Deletes a project. """ - deleteProject(input: DeleteProjectInput!): DeleteProjectPayload + deleteProject( + """ + Parameters for DeleteProject + """ + input: DeleteProjectInput! + ): DeleteProjectPayload """ Deletes a project card. """ - deleteProjectCard(input: DeleteProjectCardInput!): DeleteProjectCardPayload + deleteProjectCard( + """ + Parameters for DeleteProjectCard + """ + input: DeleteProjectCardInput! + ): DeleteProjectCardPayload """ Deletes a project column. """ - deleteProjectColumn(input: DeleteProjectColumnInput!): DeleteProjectColumnPayload + deleteProjectColumn( + """ + Parameters for DeleteProjectColumn + """ + input: DeleteProjectColumnInput! + ): DeleteProjectColumnPayload """ Deletes a pull request review. """ - deletePullRequestReview(input: DeletePullRequestReviewInput!): DeletePullRequestReviewPayload + deletePullRequestReview( + """ + Parameters for DeletePullRequestReview + """ + input: DeletePullRequestReviewInput! + ): DeletePullRequestReviewPayload """ Deletes a pull request review comment. """ - deletePullRequestReviewComment(input: DeletePullRequestReviewCommentInput!): DeletePullRequestReviewCommentPayload + deletePullRequestReviewComment( + """ + Parameters for DeletePullRequestReviewComment + """ + input: DeletePullRequestReviewCommentInput! + ): DeletePullRequestReviewCommentPayload """ Delete a Git Ref. """ - deleteRef(input: DeleteRefInput!): DeleteRefPayload + deleteRef( + """ + Parameters for DeleteRef + """ + input: DeleteRefInput! + ): DeleteRefPayload """ Deletes a team discussion. """ - deleteTeamDiscussion(input: DeleteTeamDiscussionInput!): DeleteTeamDiscussionPayload + deleteTeamDiscussion( + """ + Parameters for DeleteTeamDiscussion + """ + input: DeleteTeamDiscussionInput! + ): DeleteTeamDiscussionPayload """ Deletes a team discussion comment. """ - deleteTeamDiscussionComment(input: DeleteTeamDiscussionCommentInput!): DeleteTeamDiscussionCommentPayload + deleteTeamDiscussionComment( + """ + Parameters for DeleteTeamDiscussionComment + """ + input: DeleteTeamDiscussionCommentInput! + ): DeleteTeamDiscussionCommentPayload """ Deletes a verifiable domain. """ - deleteVerifiableDomain(input: DeleteVerifiableDomainInput!): DeleteVerifiableDomainPayload + deleteVerifiableDomain( + """ + Parameters for DeleteVerifiableDomain + """ + input: DeleteVerifiableDomainInput! + ): DeleteVerifiableDomainPayload """ Disable auto merge on the given pull request """ - disablePullRequestAutoMerge(input: DisablePullRequestAutoMergeInput!): DisablePullRequestAutoMergePayload + disablePullRequestAutoMerge( + """ + Parameters for DisablePullRequestAutoMerge + """ + input: DisablePullRequestAutoMergeInput! + ): DisablePullRequestAutoMergePayload """ Dismisses an approved or rejected pull request review. """ - dismissPullRequestReview(input: DismissPullRequestReviewInput!): DismissPullRequestReviewPayload + dismissPullRequestReview( + """ + Parameters for DismissPullRequestReview + """ + input: DismissPullRequestReviewInput! + ): DismissPullRequestReviewPayload """ Enable the default auto-merge on a pull request. """ - enablePullRequestAutoMerge(input: EnablePullRequestAutoMergeInput!): EnablePullRequestAutoMergePayload + enablePullRequestAutoMerge( + """ + Parameters for EnablePullRequestAutoMerge + """ + input: EnablePullRequestAutoMergeInput! + ): EnablePullRequestAutoMergePayload """ Follow a user. """ - followUser(input: FollowUserInput!): FollowUserPayload + followUser( + """ + Parameters for FollowUser + """ + input: FollowUserInput! + ): FollowUserPayload """ Creates a new project by importing columns and a list of issues/PRs. """ - importProject(input: ImportProjectInput!): ImportProjectPayload @preview(toggledBy: "slothette-preview") + importProject( + """ + Parameters for ImportProject + """ + input: ImportProjectInput! + ): ImportProjectPayload @preview(toggledBy: "slothette-preview") """ Invite someone to become an administrator of the enterprise. """ - inviteEnterpriseAdmin(input: InviteEnterpriseAdminInput!): InviteEnterpriseAdminPayload + inviteEnterpriseAdmin( + """ + Parameters for InviteEnterpriseAdmin + """ + input: InviteEnterpriseAdminInput! + ): InviteEnterpriseAdminPayload """ Creates a repository link for a project. """ - linkRepositoryToProject(input: LinkRepositoryToProjectInput!): LinkRepositoryToProjectPayload + linkRepositoryToProject( + """ + Parameters for LinkRepositoryToProject + """ + input: LinkRepositoryToProjectInput! + ): LinkRepositoryToProjectPayload """ Lock a lockable object """ - lockLockable(input: LockLockableInput!): LockLockablePayload + lockLockable( + """ + Parameters for LockLockable + """ + input: LockLockableInput! + ): LockLockablePayload """ Mark a pull request file as viewed """ - markFileAsViewed(input: MarkFileAsViewedInput!): MarkFileAsViewedPayload + markFileAsViewed( + """ + Parameters for MarkFileAsViewed + """ + input: MarkFileAsViewedInput! + ): MarkFileAsViewedPayload """ Marks a pull request ready for review. """ - markPullRequestReadyForReview(input: MarkPullRequestReadyForReviewInput!): MarkPullRequestReadyForReviewPayload + markPullRequestReadyForReview( + """ + Parameters for MarkPullRequestReadyForReview + """ + input: MarkPullRequestReadyForReviewInput! + ): MarkPullRequestReadyForReviewPayload """ Merge a head into a branch. """ - mergeBranch(input: MergeBranchInput!): MergeBranchPayload + mergeBranch( + """ + Parameters for MergeBranch + """ + input: MergeBranchInput! + ): MergeBranchPayload """ Merge a pull request. """ - mergePullRequest(input: MergePullRequestInput!): MergePullRequestPayload + mergePullRequest( + """ + Parameters for MergePullRequest + """ + input: MergePullRequestInput! + ): MergePullRequestPayload """ Minimizes a comment on an Issue, Commit, Pull Request, or Gist """ - minimizeComment(input: MinimizeCommentInput!): MinimizeCommentPayload + minimizeComment( + """ + Parameters for MinimizeComment + """ + input: MinimizeCommentInput! + ): MinimizeCommentPayload """ Moves a project card to another place. """ - moveProjectCard(input: MoveProjectCardInput!): MoveProjectCardPayload + moveProjectCard( + """ + Parameters for MoveProjectCard + """ + input: MoveProjectCardInput! + ): MoveProjectCardPayload """ Moves a project column to another place. """ - moveProjectColumn(input: MoveProjectColumnInput!): MoveProjectColumnPayload + moveProjectColumn( + """ + Parameters for MoveProjectColumn + """ + input: MoveProjectColumnInput! + ): MoveProjectColumnPayload """ Pin an issue to a repository """ - pinIssue(input: PinIssueInput!): PinIssuePayload @preview(toggledBy: "elektra-preview") + pinIssue( + """ + Parameters for PinIssue + """ + input: PinIssueInput! + ): PinIssuePayload """ Regenerates the identity provider recovery codes for an enterprise """ - regenerateEnterpriseIdentityProviderRecoveryCodes(input: RegenerateEnterpriseIdentityProviderRecoveryCodesInput!): RegenerateEnterpriseIdentityProviderRecoveryCodesPayload + regenerateEnterpriseIdentityProviderRecoveryCodes( + """ + Parameters for RegenerateEnterpriseIdentityProviderRecoveryCodes + """ + input: RegenerateEnterpriseIdentityProviderRecoveryCodesInput! + ): RegenerateEnterpriseIdentityProviderRecoveryCodesPayload """ Regenerates a verifiable domain's verification token. """ - regenerateVerifiableDomainToken(input: RegenerateVerifiableDomainTokenInput!): RegenerateVerifiableDomainTokenPayload + regenerateVerifiableDomainToken( + """ + Parameters for RegenerateVerifiableDomainToken + """ + input: RegenerateVerifiableDomainTokenInput! + ): RegenerateVerifiableDomainTokenPayload """ Removes assignees from an assignable object. """ - removeAssigneesFromAssignable(input: RemoveAssigneesFromAssignableInput!): RemoveAssigneesFromAssignablePayload + removeAssigneesFromAssignable( + """ + Parameters for RemoveAssigneesFromAssignable + """ + input: RemoveAssigneesFromAssignableInput! + ): RemoveAssigneesFromAssignablePayload """ Removes an administrator from the enterprise. """ - removeEnterpriseAdmin(input: RemoveEnterpriseAdminInput!): RemoveEnterpriseAdminPayload + removeEnterpriseAdmin( + """ + Parameters for RemoveEnterpriseAdmin + """ + input: RemoveEnterpriseAdminInput! + ): RemoveEnterpriseAdminPayload """ Removes the identity provider from an enterprise """ - removeEnterpriseIdentityProvider(input: RemoveEnterpriseIdentityProviderInput!): RemoveEnterpriseIdentityProviderPayload + removeEnterpriseIdentityProvider( + """ + Parameters for RemoveEnterpriseIdentityProvider + """ + input: RemoveEnterpriseIdentityProviderInput! + ): RemoveEnterpriseIdentityProviderPayload """ Removes an organization from the enterprise """ - removeEnterpriseOrganization(input: RemoveEnterpriseOrganizationInput!): RemoveEnterpriseOrganizationPayload + removeEnterpriseOrganization( + """ + Parameters for RemoveEnterpriseOrganization + """ + input: RemoveEnterpriseOrganizationInput! + ): RemoveEnterpriseOrganizationPayload """ Removes a support entitlement from an enterprise member. """ - removeEnterpriseSupportEntitlement(input: RemoveEnterpriseSupportEntitlementInput!): RemoveEnterpriseSupportEntitlementPayload + removeEnterpriseSupportEntitlement( + """ + Parameters for RemoveEnterpriseSupportEntitlement + """ + input: RemoveEnterpriseSupportEntitlementInput! + ): RemoveEnterpriseSupportEntitlementPayload """ Removes labels from a Labelable object. """ - removeLabelsFromLabelable(input: RemoveLabelsFromLabelableInput!): RemoveLabelsFromLabelablePayload + removeLabelsFromLabelable( + """ + Parameters for RemoveLabelsFromLabelable + """ + input: RemoveLabelsFromLabelableInput! + ): RemoveLabelsFromLabelablePayload """ Removes outside collaborator from all repositories in an organization. """ - removeOutsideCollaborator(input: RemoveOutsideCollaboratorInput!): RemoveOutsideCollaboratorPayload + removeOutsideCollaborator( + """ + Parameters for RemoveOutsideCollaborator + """ + input: RemoveOutsideCollaboratorInput! + ): RemoveOutsideCollaboratorPayload """ Removes a reaction from a subject. """ - removeReaction(input: RemoveReactionInput!): RemoveReactionPayload + removeReaction( + """ + Parameters for RemoveReaction + """ + input: RemoveReactionInput! + ): RemoveReactionPayload """ Removes a star from a Starrable. """ - removeStar(input: RemoveStarInput!): RemoveStarPayload + removeStar( + """ + Parameters for RemoveStar + """ + input: RemoveStarInput! + ): RemoveStarPayload """ Reopen a issue. """ - reopenIssue(input: ReopenIssueInput!): ReopenIssuePayload + reopenIssue( + """ + Parameters for ReopenIssue + """ + input: ReopenIssueInput! + ): ReopenIssuePayload """ Reopen a pull request. """ - reopenPullRequest(input: ReopenPullRequestInput!): ReopenPullRequestPayload + reopenPullRequest( + """ + Parameters for ReopenPullRequest + """ + input: ReopenPullRequestInput! + ): ReopenPullRequestPayload """ Set review requests on a pull request. """ - requestReviews(input: RequestReviewsInput!): RequestReviewsPayload + requestReviews( + """ + Parameters for RequestReviews + """ + input: RequestReviewsInput! + ): RequestReviewsPayload """ Rerequests an existing check suite. """ - rerequestCheckSuite(input: RerequestCheckSuiteInput!): RerequestCheckSuitePayload + rerequestCheckSuite( + """ + Parameters for RerequestCheckSuite + """ + input: RerequestCheckSuiteInput! + ): RerequestCheckSuitePayload """ Marks a review thread as resolved. """ - resolveReviewThread(input: ResolveReviewThreadInput!): ResolveReviewThreadPayload + resolveReviewThread( + """ + Parameters for ResolveReviewThread + """ + input: ResolveReviewThreadInput! + ): ResolveReviewThreadPayload """ Creates or updates the identity provider for an enterprise. """ - setEnterpriseIdentityProvider(input: SetEnterpriseIdentityProviderInput!): SetEnterpriseIdentityProviderPayload + setEnterpriseIdentityProvider( + """ + Parameters for SetEnterpriseIdentityProvider + """ + input: SetEnterpriseIdentityProviderInput! + ): SetEnterpriseIdentityProviderPayload """ Set an organization level interaction limit for an organization's public repositories. """ - setOrganizationInteractionLimit(input: SetOrganizationInteractionLimitInput!): SetOrganizationInteractionLimitPayload + setOrganizationInteractionLimit( + """ + Parameters for SetOrganizationInteractionLimit + """ + input: SetOrganizationInteractionLimitInput! + ): SetOrganizationInteractionLimitPayload """ Sets an interaction limit setting for a repository. """ - setRepositoryInteractionLimit(input: SetRepositoryInteractionLimitInput!): SetRepositoryInteractionLimitPayload + setRepositoryInteractionLimit( + """ + Parameters for SetRepositoryInteractionLimit + """ + input: SetRepositoryInteractionLimitInput! + ): SetRepositoryInteractionLimitPayload """ Set a user level interaction limit for an user's public repositories. """ - setUserInteractionLimit(input: SetUserInteractionLimitInput!): SetUserInteractionLimitPayload + setUserInteractionLimit( + """ + Parameters for SetUserInteractionLimit + """ + input: SetUserInteractionLimitInput! + ): SetUserInteractionLimitPayload """ Submits a pending pull request review. """ - submitPullRequestReview(input: SubmitPullRequestReviewInput!): SubmitPullRequestReviewPayload + submitPullRequestReview( + """ + Parameters for SubmitPullRequestReview + """ + input: SubmitPullRequestReviewInput! + ): SubmitPullRequestReviewPayload """ Transfer an issue to a different repository """ - transferIssue(input: TransferIssueInput!): TransferIssuePayload + transferIssue( + """ + Parameters for TransferIssue + """ + input: TransferIssueInput! + ): TransferIssuePayload """ Unarchives a repository. """ - unarchiveRepository(input: UnarchiveRepositoryInput!): UnarchiveRepositoryPayload + unarchiveRepository( + """ + Parameters for UnarchiveRepository + """ + input: UnarchiveRepositoryInput! + ): UnarchiveRepositoryPayload """ Unfollow a user. """ - unfollowUser(input: UnfollowUserInput!): UnfollowUserPayload + unfollowUser( + """ + Parameters for UnfollowUser + """ + input: UnfollowUserInput! + ): UnfollowUserPayload """ Deletes a repository link from a project. """ - unlinkRepositoryFromProject(input: UnlinkRepositoryFromProjectInput!): UnlinkRepositoryFromProjectPayload + unlinkRepositoryFromProject( + """ + Parameters for UnlinkRepositoryFromProject + """ + input: UnlinkRepositoryFromProjectInput! + ): UnlinkRepositoryFromProjectPayload """ Unlock a lockable object """ - unlockLockable(input: UnlockLockableInput!): UnlockLockablePayload + unlockLockable( + """ + Parameters for UnlockLockable + """ + input: UnlockLockableInput! + ): UnlockLockablePayload """ Unmark a pull request file as viewed """ - unmarkFileAsViewed(input: UnmarkFileAsViewedInput!): UnmarkFileAsViewedPayload + unmarkFileAsViewed( + """ + Parameters for UnmarkFileAsViewed + """ + input: UnmarkFileAsViewedInput! + ): UnmarkFileAsViewedPayload """ Unmark an issue as a duplicate of another issue. """ - unmarkIssueAsDuplicate(input: UnmarkIssueAsDuplicateInput!): UnmarkIssueAsDuplicatePayload + unmarkIssueAsDuplicate( + """ + Parameters for UnmarkIssueAsDuplicate + """ + input: UnmarkIssueAsDuplicateInput! + ): UnmarkIssueAsDuplicatePayload """ Unminimizes a comment on an Issue, Commit, Pull Request, or Gist """ - unminimizeComment(input: UnminimizeCommentInput!): UnminimizeCommentPayload + unminimizeComment( + """ + Parameters for UnminimizeComment + """ + input: UnminimizeCommentInput! + ): UnminimizeCommentPayload """ Unpin a pinned issue from a repository """ - unpinIssue(input: UnpinIssueInput!): UnpinIssuePayload @preview(toggledBy: "elektra-preview") + unpinIssue( + """ + Parameters for UnpinIssue + """ + input: UnpinIssueInput! + ): UnpinIssuePayload """ Marks a review thread as unresolved. """ - unresolveReviewThread(input: UnresolveReviewThreadInput!): UnresolveReviewThreadPayload + unresolveReviewThread( + """ + Parameters for UnresolveReviewThread + """ + input: UnresolveReviewThreadInput! + ): UnresolveReviewThreadPayload """ Create a new branch protection rule """ - updateBranchProtectionRule(input: UpdateBranchProtectionRuleInput!): UpdateBranchProtectionRulePayload + updateBranchProtectionRule( + """ + Parameters for UpdateBranchProtectionRule + """ + input: UpdateBranchProtectionRuleInput! + ): UpdateBranchProtectionRulePayload """ Update a check run """ - updateCheckRun(input: UpdateCheckRunInput!): UpdateCheckRunPayload + updateCheckRun( + """ + Parameters for UpdateCheckRun + """ + input: UpdateCheckRunInput! + ): UpdateCheckRunPayload """ Modifies the settings of an existing check suite """ - updateCheckSuitePreferences(input: UpdateCheckSuitePreferencesInput!): UpdateCheckSuitePreferencesPayload + updateCheckSuitePreferences( + """ + Parameters for UpdateCheckSuitePreferences + """ + input: UpdateCheckSuitePreferencesInput! + ): UpdateCheckSuitePreferencesPayload """ Updates the role of an enterprise administrator. """ - updateEnterpriseAdministratorRole(input: UpdateEnterpriseAdministratorRoleInput!): UpdateEnterpriseAdministratorRolePayload + updateEnterpriseAdministratorRole( + """ + Parameters for UpdateEnterpriseAdministratorRole + """ + input: UpdateEnterpriseAdministratorRoleInput! + ): UpdateEnterpriseAdministratorRolePayload """ Sets whether private repository forks are enabled for an enterprise. """ - updateEnterpriseAllowPrivateRepositoryForkingSetting(input: UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput!): UpdateEnterpriseAllowPrivateRepositoryForkingSettingPayload + updateEnterpriseAllowPrivateRepositoryForkingSetting( + """ + Parameters for UpdateEnterpriseAllowPrivateRepositoryForkingSetting + """ + input: UpdateEnterpriseAllowPrivateRepositoryForkingSettingInput! + ): UpdateEnterpriseAllowPrivateRepositoryForkingSettingPayload """ Sets the default repository permission for organizations in an enterprise. """ - updateEnterpriseDefaultRepositoryPermissionSetting(input: UpdateEnterpriseDefaultRepositoryPermissionSettingInput!): UpdateEnterpriseDefaultRepositoryPermissionSettingPayload + updateEnterpriseDefaultRepositoryPermissionSetting( + """ + Parameters for UpdateEnterpriseDefaultRepositoryPermissionSetting + """ + input: UpdateEnterpriseDefaultRepositoryPermissionSettingInput! + ): UpdateEnterpriseDefaultRepositoryPermissionSettingPayload """ Sets whether organization members with admin permissions on a repository can change repository visibility. """ - updateEnterpriseMembersCanChangeRepositoryVisibilitySetting(input: UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput!): UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingPayload + updateEnterpriseMembersCanChangeRepositoryVisibilitySetting( + """ + Parameters for UpdateEnterpriseMembersCanChangeRepositoryVisibilitySetting + """ + input: UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingInput! + ): UpdateEnterpriseMembersCanChangeRepositoryVisibilitySettingPayload """ Sets the members can create repositories setting for an enterprise. """ - updateEnterpriseMembersCanCreateRepositoriesSetting(input: UpdateEnterpriseMembersCanCreateRepositoriesSettingInput!): UpdateEnterpriseMembersCanCreateRepositoriesSettingPayload + updateEnterpriseMembersCanCreateRepositoriesSetting( + """ + Parameters for UpdateEnterpriseMembersCanCreateRepositoriesSetting + """ + input: UpdateEnterpriseMembersCanCreateRepositoriesSettingInput! + ): UpdateEnterpriseMembersCanCreateRepositoriesSettingPayload """ Sets the members can delete issues setting for an enterprise. """ - updateEnterpriseMembersCanDeleteIssuesSetting(input: UpdateEnterpriseMembersCanDeleteIssuesSettingInput!): UpdateEnterpriseMembersCanDeleteIssuesSettingPayload + updateEnterpriseMembersCanDeleteIssuesSetting( + """ + Parameters for UpdateEnterpriseMembersCanDeleteIssuesSetting + """ + input: UpdateEnterpriseMembersCanDeleteIssuesSettingInput! + ): UpdateEnterpriseMembersCanDeleteIssuesSettingPayload """ Sets the members can delete repositories setting for an enterprise. """ - updateEnterpriseMembersCanDeleteRepositoriesSetting(input: UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput!): UpdateEnterpriseMembersCanDeleteRepositoriesSettingPayload + updateEnterpriseMembersCanDeleteRepositoriesSetting( + """ + Parameters for UpdateEnterpriseMembersCanDeleteRepositoriesSetting + """ + input: UpdateEnterpriseMembersCanDeleteRepositoriesSettingInput! + ): UpdateEnterpriseMembersCanDeleteRepositoriesSettingPayload """ Sets whether members can invite collaborators are enabled for an enterprise. """ - updateEnterpriseMembersCanInviteCollaboratorsSetting(input: UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput!): UpdateEnterpriseMembersCanInviteCollaboratorsSettingPayload + updateEnterpriseMembersCanInviteCollaboratorsSetting( + """ + Parameters for UpdateEnterpriseMembersCanInviteCollaboratorsSetting + """ + input: UpdateEnterpriseMembersCanInviteCollaboratorsSettingInput! + ): UpdateEnterpriseMembersCanInviteCollaboratorsSettingPayload """ Sets whether or not an organization admin can make purchases. """ - updateEnterpriseMembersCanMakePurchasesSetting(input: UpdateEnterpriseMembersCanMakePurchasesSettingInput!): UpdateEnterpriseMembersCanMakePurchasesSettingPayload + updateEnterpriseMembersCanMakePurchasesSetting( + """ + Parameters for UpdateEnterpriseMembersCanMakePurchasesSetting + """ + input: UpdateEnterpriseMembersCanMakePurchasesSettingInput! + ): UpdateEnterpriseMembersCanMakePurchasesSettingPayload """ Sets the members can update protected branches setting for an enterprise. """ - updateEnterpriseMembersCanUpdateProtectedBranchesSetting(input: UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput!): UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingPayload + updateEnterpriseMembersCanUpdateProtectedBranchesSetting( + """ + Parameters for UpdateEnterpriseMembersCanUpdateProtectedBranchesSetting + """ + input: UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingInput! + ): UpdateEnterpriseMembersCanUpdateProtectedBranchesSettingPayload """ Sets the members can view dependency insights for an enterprise. """ - updateEnterpriseMembersCanViewDependencyInsightsSetting(input: UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput!): UpdateEnterpriseMembersCanViewDependencyInsightsSettingPayload + updateEnterpriseMembersCanViewDependencyInsightsSetting( + """ + Parameters for UpdateEnterpriseMembersCanViewDependencyInsightsSetting + """ + input: UpdateEnterpriseMembersCanViewDependencyInsightsSettingInput! + ): UpdateEnterpriseMembersCanViewDependencyInsightsSettingPayload """ Sets whether organization projects are enabled for an enterprise. """ - updateEnterpriseOrganizationProjectsSetting(input: UpdateEnterpriseOrganizationProjectsSettingInput!): UpdateEnterpriseOrganizationProjectsSettingPayload + updateEnterpriseOrganizationProjectsSetting( + """ + Parameters for UpdateEnterpriseOrganizationProjectsSetting + """ + input: UpdateEnterpriseOrganizationProjectsSettingInput! + ): UpdateEnterpriseOrganizationProjectsSettingPayload """ Updates an enterprise's profile. """ - updateEnterpriseProfile(input: UpdateEnterpriseProfileInput!): UpdateEnterpriseProfilePayload + updateEnterpriseProfile( + """ + Parameters for UpdateEnterpriseProfile + """ + input: UpdateEnterpriseProfileInput! + ): UpdateEnterpriseProfilePayload """ Sets whether repository projects are enabled for a enterprise. """ - updateEnterpriseRepositoryProjectsSetting(input: UpdateEnterpriseRepositoryProjectsSettingInput!): UpdateEnterpriseRepositoryProjectsSettingPayload + updateEnterpriseRepositoryProjectsSetting( + """ + Parameters for UpdateEnterpriseRepositoryProjectsSetting + """ + input: UpdateEnterpriseRepositoryProjectsSettingInput! + ): UpdateEnterpriseRepositoryProjectsSettingPayload """ Sets whether team discussions are enabled for an enterprise. """ - updateEnterpriseTeamDiscussionsSetting(input: UpdateEnterpriseTeamDiscussionsSettingInput!): UpdateEnterpriseTeamDiscussionsSettingPayload + updateEnterpriseTeamDiscussionsSetting( + """ + Parameters for UpdateEnterpriseTeamDiscussionsSetting + """ + input: UpdateEnterpriseTeamDiscussionsSettingInput! + ): UpdateEnterpriseTeamDiscussionsSettingPayload """ Sets whether two factor authentication is required for all users in an enterprise. """ - updateEnterpriseTwoFactorAuthenticationRequiredSetting(input: UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput!): UpdateEnterpriseTwoFactorAuthenticationRequiredSettingPayload + updateEnterpriseTwoFactorAuthenticationRequiredSetting( + """ + Parameters for UpdateEnterpriseTwoFactorAuthenticationRequiredSetting + """ + input: UpdateEnterpriseTwoFactorAuthenticationRequiredSettingInput! + ): UpdateEnterpriseTwoFactorAuthenticationRequiredSettingPayload """ Sets whether an IP allow list is enabled on an owner. """ - updateIpAllowListEnabledSetting(input: UpdateIpAllowListEnabledSettingInput!): UpdateIpAllowListEnabledSettingPayload + updateIpAllowListEnabledSetting( + """ + Parameters for UpdateIpAllowListEnabledSetting + """ + input: UpdateIpAllowListEnabledSettingInput! + ): UpdateIpAllowListEnabledSettingPayload """ Updates an IP allow list entry. """ - updateIpAllowListEntry(input: UpdateIpAllowListEntryInput!): UpdateIpAllowListEntryPayload + updateIpAllowListEntry( + """ + Parameters for UpdateIpAllowListEntry + """ + input: UpdateIpAllowListEntryInput! + ): UpdateIpAllowListEntryPayload """ Updates an Issue. """ - updateIssue(input: UpdateIssueInput!): UpdateIssuePayload + updateIssue( + """ + Parameters for UpdateIssue + """ + input: UpdateIssueInput! + ): UpdateIssuePayload """ Updates an IssueComment object. """ - updateIssueComment(input: UpdateIssueCommentInput!): UpdateIssueCommentPayload + updateIssueComment( + """ + Parameters for UpdateIssueComment + """ + input: UpdateIssueCommentInput! + ): UpdateIssueCommentPayload """ Updates an existing label. """ - updateLabel(input: UpdateLabelInput!): UpdateLabelPayload @preview(toggledBy: "bane-preview") + updateLabel( + """ + Parameters for UpdateLabel + """ + input: UpdateLabelInput! + ): UpdateLabelPayload @preview(toggledBy: "bane-preview") """ Update the setting to restrict notifications to only verified domains available to an owner. """ - updateNotificationRestrictionSetting(input: UpdateNotificationRestrictionSettingInput!): UpdateNotificationRestrictionSettingPayload + updateNotificationRestrictionSetting( + """ + Parameters for UpdateNotificationRestrictionSetting + """ + input: UpdateNotificationRestrictionSettingInput! + ): UpdateNotificationRestrictionSettingPayload """ Updates an existing project. """ - updateProject(input: UpdateProjectInput!): UpdateProjectPayload + updateProject( + """ + Parameters for UpdateProject + """ + input: UpdateProjectInput! + ): UpdateProjectPayload """ Updates an existing project card. """ - updateProjectCard(input: UpdateProjectCardInput!): UpdateProjectCardPayload + updateProjectCard( + """ + Parameters for UpdateProjectCard + """ + input: UpdateProjectCardInput! + ): UpdateProjectCardPayload """ Updates an existing project column. """ - updateProjectColumn(input: UpdateProjectColumnInput!): UpdateProjectColumnPayload + updateProjectColumn( + """ + Parameters for UpdateProjectColumn + """ + input: UpdateProjectColumnInput! + ): UpdateProjectColumnPayload """ Update a pull request """ - updatePullRequest(input: UpdatePullRequestInput!): UpdatePullRequestPayload + updatePullRequest( + """ + Parameters for UpdatePullRequest + """ + input: UpdatePullRequestInput! + ): UpdatePullRequestPayload """ Updates the body of a pull request review. """ - updatePullRequestReview(input: UpdatePullRequestReviewInput!): UpdatePullRequestReviewPayload + updatePullRequestReview( + """ + Parameters for UpdatePullRequestReview + """ + input: UpdatePullRequestReviewInput! + ): UpdatePullRequestReviewPayload """ Updates a pull request review comment. """ - updatePullRequestReviewComment(input: UpdatePullRequestReviewCommentInput!): UpdatePullRequestReviewCommentPayload + updatePullRequestReviewComment( + """ + Parameters for UpdatePullRequestReviewComment + """ + input: UpdatePullRequestReviewCommentInput! + ): UpdatePullRequestReviewCommentPayload """ Update a Git Ref. """ - updateRef(input: UpdateRefInput!): UpdateRefPayload + updateRef( + """ + Parameters for UpdateRef + """ + input: UpdateRefInput! + ): UpdateRefPayload """ Creates, updates and/or deletes multiple refs in a repository. @@ -15994,42 +16714,82 @@ type Mutation { If `RefUpdate.force` is set to `true`, a non-fast-forward updates for the given reference will be allowed. """ - updateRefs(input: UpdateRefsInput!): UpdateRefsPayload @preview(toggledBy: "update-refs-preview") + updateRefs( + """ + Parameters for UpdateRefs + """ + input: UpdateRefsInput! + ): UpdateRefsPayload @preview(toggledBy: "update-refs-preview") """ Update information about a repository. """ - updateRepository(input: UpdateRepositoryInput!): UpdateRepositoryPayload + updateRepository( + """ + Parameters for UpdateRepository + """ + input: UpdateRepositoryInput! + ): UpdateRepositoryPayload """ Updates the state for subscribable subjects. """ - updateSubscription(input: UpdateSubscriptionInput!): UpdateSubscriptionPayload + updateSubscription( + """ + Parameters for UpdateSubscription + """ + input: UpdateSubscriptionInput! + ): UpdateSubscriptionPayload """ Updates a team discussion. """ - updateTeamDiscussion(input: UpdateTeamDiscussionInput!): UpdateTeamDiscussionPayload + updateTeamDiscussion( + """ + Parameters for UpdateTeamDiscussion + """ + input: UpdateTeamDiscussionInput! + ): UpdateTeamDiscussionPayload """ Updates a discussion comment. """ - updateTeamDiscussionComment(input: UpdateTeamDiscussionCommentInput!): UpdateTeamDiscussionCommentPayload + updateTeamDiscussionComment( + """ + Parameters for UpdateTeamDiscussionComment + """ + input: UpdateTeamDiscussionCommentInput! + ): UpdateTeamDiscussionCommentPayload """ Updates team review assignment. """ - updateTeamReviewAssignment(input: UpdateTeamReviewAssignmentInput!): UpdateTeamReviewAssignmentPayload @preview(toggledBy: "stone-crop-preview") + updateTeamReviewAssignment( + """ + Parameters for UpdateTeamReviewAssignment + """ + input: UpdateTeamReviewAssignmentInput! + ): UpdateTeamReviewAssignmentPayload @preview(toggledBy: "stone-crop-preview") """ Replaces the repository's topics with the given topics. """ - updateTopics(input: UpdateTopicsInput!): UpdateTopicsPayload + updateTopics( + """ + Parameters for UpdateTopics + """ + input: UpdateTopicsInput! + ): UpdateTopicsPayload """ Verify that a verifiable domain has the expected DNS record. """ - verifyVerifiableDomain(input: VerifyVerifiableDomainInput!): VerifyVerifiableDomainPayload + verifyVerifiableDomain( + """ + Parameters for VerifyVerifiableDomain + """ + input: VerifyVerifiableDomainInput! + ): VerifyVerifiableDomainPayload } """ @@ -19339,7 +20099,7 @@ type Organization implements Actor & MemberStatusable & Node & PackageOwner & Pr """ Filter by if the domain is verified. """ - isVerified: Boolean + isVerified: Boolean = null """ Returns the last _n_ elements from the list. @@ -21237,7 +21997,7 @@ type PinnedEvent implements Node { """ A Pinned Issue is a issue pinned to a repository's index page. """ -type PinnedIssue implements Node @preview(toggledBy: "elektra-preview") { +type PinnedIssue implements Node { """ Identifies the primary key from the database. """ @@ -21263,7 +22023,7 @@ type PinnedIssue implements Node @preview(toggledBy: "elektra-preview") { """ The connection type for PinnedIssue. """ -type PinnedIssueConnection @preview(toggledBy: "elektra-preview") { +type PinnedIssueConnection { """ A list of edges. """ @@ -21288,7 +22048,7 @@ type PinnedIssueConnection @preview(toggledBy: "elektra-preview") { """ An edge in a connection. """ -type PinnedIssueEdge @preview(toggledBy: "elektra-preview") { +type PinnedIssueEdge { """ A cursor for use in pagination. """ @@ -26332,6 +27092,11 @@ type Release implements Node & UniformResourceLocatable { """ tag: Ref + """ + The tag commit for this release. + """ + tagCommit: Commit + """ The name of the release's Git tag """ @@ -30123,7 +30888,7 @@ type Repository implements Node & PackageOwner & ProjectOwner & RepositoryInfo & Returns the last _n_ elements from the list. """ last: Int - ): PinnedIssueConnection @preview(toggledBy: "elektra-preview") + ): PinnedIssueConnection """ The primary language of the repository's code. @@ -39204,6 +39969,11 @@ type User implements Actor & Node & PackageOwner & ProfileOwner & ProjectOwner & """ isEmployee: Boolean! + """ + Whether or not this user is a member of the GitHub Stars Program. + """ + isGitHubStar: Boolean! + """ Whether or not the user has marked themselves as for hire. """ @@ -40353,6 +41123,11 @@ enum UserStatusOrderField { A domain that can be verified for an organization or an enterprise. """ type VerifiableDomain implements Node { + """ + Identifies the date and time when the object was created. + """ + createdAt: DateTime! + """ Identifies the primary key from the database. """ @@ -40404,6 +41179,11 @@ type VerifiableDomain implements Node { """ tokenExpirationTime: DateTime + """ + Identifies the date and time when the object was last updated. + """ + updatedAt: DateTime! + """ The current verification token for the domain. """ @@ -40469,6 +41249,11 @@ input VerifiableDomainOrder { Properties by which verifiable domain connections can be ordered. """ enum VerifiableDomainOrderField { + """ + Order verifiable domains by their creation date. + """ + CREATED_AT + """ Order verifiable domains by the domain name. """ diff --git a/data/release-notes/2-20/24.yml b/data/release-notes/2-20/24.yml new file mode 100644 index 000000000000..c9c6470ca08e --- /dev/null +++ b/data/release-notes/2-20/24.yml @@ -0,0 +1,27 @@ +date: '2021-03-02' +sections: + security_fixes: + - '**HIGH:** An improper access control vulnerability was identified in GitHub Enterprise Server that allowed authenticated users of the instance to gain write access to unauthorized repositories via specifically crafted pull requests and REST API requests. An attacker would need to be able to fork the targeted repository, a setting that is disabled by default for organization owned private repositories. Branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22861. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**HIGH:** An improper access control vulnerability was identified in the GitHub Enterprise Server GraphQL API that allowed authenticated users of the instance to modify the maintainer collaboration permission of a pull request without proper authorization. By exploiting this vulnerability, an attacker would be able to gain access to head branches of pull requests opened on repositories of which they are a maintainer. Forking is disabled by default for organization owned private repositories and would prevent this vulnerability. Additionally, branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22863. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**HIGH:** A remote code execution vulnerability was identified in GitHub Enterprise Server that could be exploited when building a GitHub Pages site. User-controlled configuration of the underlying parsers used by GitHub Pages were not sufficiently restricted and made it possible to execute commands on the GitHub Enterprise Server instance. To exploit this vulnerability, an attacker would need permission to create and build a GitHub Pages site on the GitHub Enterprise Server instance. This vulnerability has been assigned CVE-2020-10519 and was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**LOW:** A specially crafted request to the SVN bridge could trigger a long wait before failure resulting in Denial of Service (DoS).' + - 'Packages have been updated to the latest security versions.' + bugs: + - 'An informational message was unintentionally logged as an error during GitHub Enterprise Backup Utilities snapshots, which resulted in unnecessary emails being sent when backups were scheduled by cron jobs that listen for output to stderr.' + - 'While restoring a large backup, exception logging related to Redis memory exhaustion could cause the restore to fail due to a full disk.' + - 'When editing a wiki page a user could experience a 500 error when clicking the Save button.' + - 'An S/MIME signed commit using a certificate with multiple names in the subject alternative name would incorrectly show as "Unverified" in the commit badge.' + - 'Suspended user was sent emails when added to a team.' + - 'When uploading a new license file with a different number of seats from the previous license file, the seat difference was not correctly represented in the enterprise account Settings -> License page.' + - 'The "Prevent repository admins from changing anonymous Git read access" checkbox available in the enterprise account settings could not be successfully enabled or disabled.' + - 'During a leap year, the user was getting a 404 response when trying to view Contribution activity on a Monday.' + changes: + - 'Added support for [AWS EC2 r5b instance types](https://aws.amazon.com/about-aws/whats-new/2020/12/introducing-new-amazon-ec2-r5b-instances-featuring-60-gbps-of-ebs-bandwidth-and-260K-iops/).' + - 'Adjusted background queue prioritization to more evenly distribute jobs.' + known_issues: + - 'On a freshly set up GitHub Enterprise Server without any users, an attacker could create the first admin user.' + - 'Custom firewall rules are not maintained during an upgrade.' + - 'Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository.' + - 'Issues cannot be closed if they contain a permalink to a blob in the same repository where the file path is longer than 255 characters.' + - 'When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results.' + - 'Security alerts are not reported when pushing to a repository on the command line.' diff --git a/data/release-notes/2-21/15.yml b/data/release-notes/2-21/15.yml new file mode 100644 index 000000000000..7926760a99c3 --- /dev/null +++ b/data/release-notes/2-21/15.yml @@ -0,0 +1,32 @@ +date: '2021-03-02' +sections: + security_fixes: + - '**HIGH:** An improper access control vulnerability was identified in GitHub Enterprise Server that allowed authenticated users of the instance to gain write access to unauthorized repositories via specifically crafted pull requests and REST API requests. An attacker would need to be able to fork the targeted repository, a setting that is disabled by default for organization owned private repositories. Branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22861. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**HIGH:** An improper access control vulnerability was identified in the GitHub Enterprise Server GraphQL API that allowed authenticated users of the instance to modify the maintainer collaboration permission of a pull request without proper authorization. By exploiting this vulnerability, an attacker would be able to gain access to head branches of pull requests opened on repositories of which they are a maintainer. Forking is disabled by default for organization owned private repositories and would prevent this vulnerability. Additionally, branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22863. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**HIGH:** A remote code execution vulnerability was identified in GitHub Enterprise Server that could be exploited when building a GitHub Pages site. User-controlled configuration of the underlying parsers used by GitHub Pages were not sufficiently restricted and made it possible to execute commands on the GitHub Enterprise Server instance. To exploit this vulnerability, an attacker would need permission to create and build a GitHub Pages site on the GitHub Enterprise Server instance. This vulnerability has been assigned CVE-2020-10519 and was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**MEDIUM:** GitHub Tokens from GitHub Pages builds could end up in logs.' + - '**LOW:** A specially crafted request to the SVN bridge could trigger a long wait before failure resulting in Denial of Service (DoS).' + - 'Packages have been updated to the latest security versions.' + bugs: + - 'The load-balancer health checks in some cases could cause the babeld logs to fill up with errors about the PROXY protocol.' + - 'An informational message was unintentionally logged as an error during GitHub Enterprise Backup Utilities snapshots, which resulted in unnecessary emails being sent when backups were scheduled by cron jobs that listen for output to stderr.' + - 'While restoring a large backup, exception logging related to Redis memory exhaustion could cause the restore to fail due to a full disk.' + - 'When editing a wiki page a user could experience a 500 error when clicking the Save button.' + - 'An S/MIME signed commit using a certificate with multiple names in the subject alternative name would incorrectly show as "Unverified" in the commit badge.' + - 'Suspended user was sent emails when added to a team.' + - 'When a repository had a large number of manifests an error `You have reached the maximum number of allowed manifest files (20) for this repository.` was shown on the Insights -> Dependency graph tab. For more information, see [Visualization limits](https://docs.github.com/en/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies#are-there-limits-which-affect-the-dependency-graph-data).' + - 'When uploading a new license file with a different number of seats from the previous license file, the seat difference was not correctly represented in the enterprise account Settings -> License page.' + - 'The "Prevent repository admins from changing anonymous Git read access" checkbox available in the enterprise account settings could not be successfully enabled or disabled.' + - 'When a GitHub Pages build failed, the email notification contained an incorrect link for support location.' + - 'During a leap year, the user was getting a 404 response when trying to view Contribution activity on a Monday.' + - 'Visiting the *Explore* section failed with a 500 Internal Server error.' + changes: + - 'Added support for [AWS EC2 r5b instance types](https://aws.amazon.com/about-aws/whats-new/2020/12/introducing-new-amazon-ec2-r5b-instances-featuring-60-gbps-of-ebs-bandwidth-and-260K-iops/).' + - 'Adjusted background queue prioritization to more evenly distribute jobs.' + known_issues: + - 'On a freshly set up GitHub Enterprise Server without any users, an attacker could create the first admin user.' + - 'Custom firewall rules are not maintained during an upgrade.' + - 'Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository.' + - 'Issues cannot be closed if they contain a permalink to a blob in the same repository where the file path is longer than 255 characters.' + - 'When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results.' + - 'Security alerts are not reported when pushing to a repository on the command line.' diff --git a/data/release-notes/2-22/7.yml b/data/release-notes/2-22/7.yml new file mode 100644 index 000000000000..e443324f3646 --- /dev/null +++ b/data/release-notes/2-22/7.yml @@ -0,0 +1,34 @@ +date: '2021-03-02' +sections: + security_fixes: + - '**HIGH:** An improper access control vulnerability was identified in GitHub Enterprise Server that allowed authenticated users of the instance to gain write access to unauthorized repositories via specifically crafted pull requests and REST API requests. An attacker would need to be able to fork the targeted repository, a setting that is disabled by default for organization owned private repositories. Branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22861. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**HIGH:** An improper access control vulnerability was identified in the GitHub Enterprise Server GraphQL API that allowed authenticated users of the instance to modify the maintainer collaboration permission of a pull request without proper authorization. By exploiting this vulnerability, an attacker would be able to gain access to head branches of pull requests opened on repositories of which they are a maintainer. Forking is disabled by default for organization owned private repositories and would prevent this vulnerability. Additionally, branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22863. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**HIGH:** A remote code execution vulnerability was identified in GitHub Enterprise Server that could be exploited when building a GitHub Pages site. User-controlled configuration of the underlying parsers used by GitHub Pages were not sufficiently restricted and made it possible to execute commands on the GitHub Enterprise Server instance. To exploit this vulnerability, an attacker would need permission to create and build a GitHub Pages site on the GitHub Enterprise Server instance. This vulnerability has been assigned CVE-2020-10519 and was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**MEDIUM:** GitHub Tokens from GitHub Pages builds could end up in logs.' + - '**LOW:** A specially crafted request to the SVN bridge could trigger a long wait before failure resulting in Denial of Service (DoS).' + - 'Packages have been updated to the latest security versions.' + bugs: + - 'The load-balancer health checks in some cases could cause the babeld logs to fill up with errors about the PROXY protocol.' + - 'An informational message was unintentionally logged as an error during GitHub Enterprise Backup Utilities snapshots, which resulted in unnecessary emails being sent when backups were scheduled by cron jobs that listen for output to stderr.' + - 'While restoring a large backup, exception logging related to Redis memory exhaustion could cause the restore to fail due to a full disk.' + - 'When first setting up a new instance, if you selected "Configure as Replica" you would be unable to start replication.' + - 'When GitHub Actions was enabled, disabling maintenance mode in the management console failed.' + - 'When editing a wiki page a user could experience a 500 error when clicking the Save button.' + - 'An S/MIME signed commit using a certificate with multiple names in the subject alternative name would incorrectly show as "Unverified" in the commit badge.' + - 'Suspended user was sent emails when added to a team.' + - 'User saw 500 error when executing git operations on an instance configured with LDAP authentication.' + - 'The `remove_org_member_package_access` background job was visible in the management console and would continually increase.' + - 'When a repository had a large number of manifests an error `You have reached the maximum number of allowed manifest files (20) for this repository.` was shown on the Insights -> Dependency graph tab. For more information, see [Visualization limits](https://docs.github.com/en/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies#are-there-limits-which-affect-the-dependency-graph-data).' + - 'When uploading a new license file with a different number of seats from the previous license file, the seat difference was not correctly represented in the enterprise account Settings -> License page.' + - 'The "Prevent repository admins from changing anonymous Git read access" checkbox available in the enterprise account settings could not be successfully enabled or disabled.' + - 'When a GitHub Pages build failed, the email notification contained an incorrect link for support location.' + - 'During a leap year, the user was getting a 404 response when trying to view Contribution activity on a Monday.' + changes: + - 'Added support for [AWS EC2 r5b instance types](https://aws.amazon.com/about-aws/whats-new/2020/12/introducing-new-amazon-ec2-r5b-instances-featuring-60-gbps-of-ebs-bandwidth-and-260K-iops/).' + - 'Adjusted background queue prioritization to more evenly distribute jobs.' + known_issues: + - 'On a freshly set up GitHub Enterprise Server without any users, an attacker could create the first admin user.' + - 'Custom firewall rules are not maintained during an upgrade.' + - 'Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository.' + - 'Issues cannot be closed if they contain a permalink to a blob in the same repository where the file path is longer than 255 characters.' + - 'When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results.' diff --git a/data/release-notes/3-0/0.yml b/data/release-notes/3-0/0.yml index 0ba564dd7f8e..e9c29178ca1a 100644 --- a/data/release-notes/3-0/0.yml +++ b/data/release-notes/3-0/0.yml @@ -1,6 +1,8 @@ date: '2021-02-16' intro: The minimum infrastructure requirements have increased for {% data variables.product.prodname_ghe_server %} 3.0+. For more information, see "[About minimum requirements for GitHub Enterprise Server 3.0 and later](/admin/enterprise-management/upgrading-github-enterprise-server#about-minimum-requirements-for-github-enterprise-server-30-and-later)." sections: + security_fixes: + - '**HIGH:** A remote code execution vulnerability was identified in {% data variables.product.prodname_ghe_server %} that could be exploited when building a {% data variables.product.prodname_pages %} site. User-controlled configuration of the underlying parsers used by {% data variables.product.prodname_pages %} were not sufficiently restricted and made it possible to execute commands on the {% data variables.product.prodname_ghe_server %} instance. To exploit this vulnerability, an attacker would need permission to create and build a {% data variables.product.prodname_pages %} site on the {% data variables.product.prodname_ghe_server %} instance. This vulnerability has been assigned CVE-2020-10519 and was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' features: - heading: GitHub Actions notes: diff --git a/data/release-notes/3-0/1.yml b/data/release-notes/3-0/1.yml new file mode 100644 index 000000000000..a83d79f35004 --- /dev/null +++ b/data/release-notes/3-0/1.yml @@ -0,0 +1,36 @@ +date: '2021-03-02' +sections: + security_fixes: + - '**HIGH:** An improper access control vulnerability was identified in GitHub Enterprise Server that allowed authenticated users of the instance to gain write access to unauthorized repositories via specifically crafted pull requests and REST API requests. An attacker would need to be able to fork the targeted repository, a setting that is disabled by default for organization owned private repositories. Branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22861. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**HIGH:** An improper access control vulnerability was identified in the GitHub Enterprise Server GraphQL API that allowed authenticated users of the instance to modify the maintainer collaboration permission of a pull request without proper authorization. By exploiting this vulnerability, an attacker would be able to gain access to head branches of pull requests opened on repositories of which they are a maintainer. Forking is disabled by default for organization owned private repositories and would prevent this vulnerability. Additionally, branch protections such as required pull request reviews or status checks would prevent unauthorized commits from being merged without further review or validation. This vulnerability has been assigned CVE-2021-22863. This issue was reported via the [GitHub Bug Bounty Program](https://bounty.github.com).' + - '**HIGH:** An improper access control vulnerability was identified in GitHub Enterprise Server that allowed an authenticated user with the ability to fork a repository to disclose Actions secrets for the parent repository of the fork. This vulnerability existed due to a flaw that allowed the base reference of a pull request to be updated to point to an arbitrary SHA or another pull request outside of the fork repository. By establishing this incorrect reference in a PR, the restrictions that limit the Actions secrets sent a workflow from forks could be bypassed. This vulnerability affected GitHub Enterprise Server versions 3.0.0, 3.0.0.rc2, and 3.0.0.rc1 and has been assigned CVE-2021-22862. This vulnerability was reported via the GitHub Bug Bounty program.' + - '**MEDIUM:** GitHub Tokens from GitHub Pages builds could end up in logs.' + - 'Packages have been updated to the latest security versions.' + bugs: + - 'The load-balancer health checks in some cases could cause the babeld logs to fill up with errors about the PROXY protocol.' + - 'The HTTP headers were not compliant with HTTP RFC standards in specific responses like 304 status for archives.' + - 'On instances that host Python repositories with the Dependency Graph feature enabled, the instance could become unresponsive due to the root disk filling with error logs.' + - 'An informational message was unintentionally logged as an error during GitHub Enterprise Backup Utilities snapshots, which resulted in unnecessary emails being sent when backups were scheduled by cron jobs that listen for output to stderr.' + - 'On VMWare ESX 6.7 the initial configuration could hang while creating host keys which left the instance inaccessible via SSH.' + - 'When GitHub Actions was enabled, disabling maintenance mode in the management console failed.' + - 'The Package creation setting was shown on the organization member settings page, though this feature is not yet available.' + - 'While enabling secret scanning on the Security & Analysis page the dialog incorrectly mentions private repositories.' + - 'When editing a wiki page a user could experience a 500 error when clicking the Save button.' + - 'An S/MIME signed commit using a certificate with multiple names in the subject alternative name would incorrectly show as "Unverified" in the commit badge.' + - 'User saw 500 error when executing git operations on an instance configured with LDAP authentication.' + - 'Suspended user was sent emails when added to a team.' + - 'When a repository had a large number of manifests an error `You have reached the maximum number of allowed manifest files (20) for this repository.` was shown on the Insights -> Dependency graph tab. For more information, see [Visualization limits](https://docs.github.com/en/github/managing-security-vulnerabilities/troubleshooting-the-detection-of-vulnerable-dependencies#are-there-limits-which-affect-the-dependency-graph-data).' + - 'Fixes users being shown the option to set up the Code Scanning CodeQL Action even if Actions was not enabled for their repository.' + - 'The "Prevent repository admins from changing anonymous Git read access" checkbox available in the enterprise account settings could not be successfully enabled or disabled.' + - 'The modal used to display a mandatory message contained no vertical scrollbar, meaning longer messages could not be viewed in full.' + - 'Users could dismiss a mandatory message without checking all checkboxes.' + - 'Redis would sometimes fail to start after a hard reboot or application crash.' + changes: + - 'Satisfy requests concurrently when multiple users are downloading the same archive, resulting in improved performance.' + known_issues: + - 'On a freshly set up GitHub Enterprise Server without any users, an attacker could create the first admin user.' + - 'Custom firewall rules are not maintained during an upgrade.' + - 'Git LFS tracked files [uploaded through the web interface](https://github.com/blog/2105-upload-files-to-your-repositories) are incorrectly added directly to the repository.' + - 'Issues cannot be closed if they contain a permalink to a blob in the same repository where the file path is longer than 255 characters.' + - 'When "Users can search GitHub.com" is enabled with GitHub Connect, issues in private and internal repositories are not included in GitHub.com search results.' + - 'When maintenance mode is enabled, some services continue to be listed as "active processes". The services identified are expected to run during maintenance mode. If you experience this issue and are unsure, contact [GitHub Enterprise Support](https://enterprise.githubsupport.com/hc/en-us) or [GitHub Premium Support](https://premium.githubsupport.com/).' diff --git a/data/reusables/actions/about-secrets.md b/data/reusables/actions/about-secrets.md index 073ff29d32f3..8ee1bee11699 100644 --- a/data/reusables/actions/about-secrets.md +++ b/data/reusables/actions/about-secrets.md @@ -1 +1 @@ -Encrypted secrets allow you to store sensitive information, such as access tokens, in your repository{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}, repository environments,{% endif %} or organization. \ No newline at end of file +Encrypted secrets allow you to store sensitive information, such as access tokens, in your repository{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}, repository environments,{% endif %} or organization. \ No newline at end of file diff --git a/data/reusables/actions/actions-authentication.md b/data/reusables/actions/actions-authentication.md index a047e0b5c463..920079439500 100644 --- a/data/reusables/actions/actions-authentication.md +++ b/data/reusables/actions/actions-authentication.md @@ -1 +1 @@ -This API is available for authenticated users, {% data variables.product.prodname_oauth_app %}s, and {% data variables.product.prodname_github_app %}s. Access tokens require [`repo` scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes) for private repos and [`public_repo` scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes) for public repos. +This API is available for authenticated users, {% data variables.product.prodname_oauth_app %}s, and {% data variables.product.prodname_github_app %}s. Access tokens require [`repo` scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes) for private repos and [`public_repo` scope](/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/#available-scopes) for {% if currentVersion == "github-ae@latest" %} for internal repos that are available to everyone on the enterprise.{% else %}public repos.{% endif %} diff --git a/data/reusables/actions/ae-beta.md b/data/reusables/actions/ae-beta.md new file mode 100644 index 000000000000..0724c250bf63 --- /dev/null +++ b/data/reusables/actions/ae-beta.md @@ -0,0 +1,7 @@ +{% if currentVersion == "github-ae@latest" %} +{% note %} + +**Note:** {% data variables.product.prodname_actions %} is currently in beta for {% data variables.product.prodname_ghe_managed %}. + +{% endnote %} +{% endif %} diff --git a/data/reusables/actions/ae-self-hosted-runners-notice.md b/data/reusables/actions/ae-self-hosted-runners-notice.md new file mode 100644 index 000000000000..6d854cf0bbc7 --- /dev/null +++ b/data/reusables/actions/ae-self-hosted-runners-notice.md @@ -0,0 +1,9 @@ +{% if currentVersion == "github-ae@latest" %} +{% warning %} + +** Warning:** Self-hosted runners are currently disabled for {% data variables.product.prodname_ghe_managed %}. This is because {% data variables.product.prodname_ghe_managed %} offers guarantees for security boundaries which are incompatible with how self-hosted runners work. However, if you do need to use self-hosted runners with {% data variables.product.prodname_ghe_managed %} and understand the security implications, you can contact {% data variables.product.prodname_dotcom %} support for a security exception that will enable self-hosted runners. + +If you don't need self-hosted runners, then you can use {% data variables.actions.hosted_runner %}s to run your workflows. For more information, see "[About {% data variables.actions.hosted_runner %}s](/actions/using-github-hosted-runners/about-ae-hosted-runners)." + +{% endwarning %} +{% endif %} diff --git a/data/reusables/actions/enterprise-setup-prereq.md b/data/reusables/actions/enterprise-setup-prereq.md index 664651119243..16e647c0971c 100644 --- a/data/reusables/actions/enterprise-setup-prereq.md +++ b/data/reusables/actions/enterprise-setup-prereq.md @@ -1,4 +1,4 @@ -{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %} +{% if enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} #### Using self-hosted runners on {% data variables.product.prodname_ghe_server %} diff --git a/data/reusables/actions/environments-beta.md b/data/reusables/actions/environments-beta.md index 5fe1386417b5..0ab094d719aa 100644 --- a/data/reusables/actions/environments-beta.md +++ b/data/reusables/actions/environments-beta.md @@ -1,4 +1,4 @@ -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} {% note %} diff --git a/data/reusables/actions/visualization-beta.md b/data/reusables/actions/visualization-beta.md index ee3ad11ef4b9..da3ac2b0d2b4 100644 --- a/data/reusables/actions/visualization-beta.md +++ b/data/reusables/actions/visualization-beta.md @@ -1,4 +1,4 @@ -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} {% note %} **Note:** The workflow visualization graph for {% data variables.product.prodname_actions %} is currently in beta and subject to change. diff --git a/data/reusables/advanced-security/more-info-ghas.md b/data/reusables/advanced-security/more-info-ghas.md index 4a510456e92e..e3602931e45f 100644 --- a/data/reusables/advanced-security/more-info-ghas.md +++ b/data/reusables/advanced-security/more-info-ghas.md @@ -1,3 +1,3 @@ -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} For more information, see "[About {% data variables.product.prodname_GH_advanced_security %}](/github/getting-started-with-github/about-github-advanced-security)." {% endif %} diff --git a/data/reusables/code-scanning/about-code-scanning.md b/data/reusables/code-scanning/about-code-scanning.md index 054042ee8c75..6d556ec455c3 100644 --- a/data/reusables/code-scanning/about-code-scanning.md +++ b/data/reusables/code-scanning/about-code-scanning.md @@ -1 +1 @@ -{% data variables.product.prodname_code_scanning_capc %} is a feature that you use to analyze the code in a {% data variables.product.prodname_dotcom %} repository to find security vulnerabilities and coding errors. Any problems identified by the analysis are shown in {% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}{% data variables.product.prodname_ghe_server %}{% else %}{% data variables.product.prodname_dotcom %}{% endif %}. +{% data variables.product.prodname_code_scanning_capc %} is a feature that you use to analyze the code in a {% data variables.product.prodname_dotcom %} repository to find security vulnerabilities and coding errors. Any problems identified by the analysis are shown in {% data variables.product.product_name %}. diff --git a/data/reusables/code-scanning/beta.md b/data/reusables/code-scanning/beta.md index 7d1b5dbc9479..9da0119339e9 100644 --- a/data/reusables/code-scanning/beta.md +++ b/data/reusables/code-scanning/beta.md @@ -6,4 +6,12 @@ {% endnote %} +{% elsif currentVersion == "github-ae@latest" %} + +{% note %} + +**Note:** {% data variables.product.prodname_code_scanning_capc %} is currently in beta and subject to change. + +{% endnote %} + {% endif %} diff --git a/data/reusables/code-scanning/custom-configuration-file.md b/data/reusables/code-scanning/custom-configuration-file.md new file mode 100644 index 000000000000..69fcb66027c2 --- /dev/null +++ b/data/reusables/code-scanning/custom-configuration-file.md @@ -0,0 +1 @@ +The configuration file can be located within the repository you are analyzing, or in an external repository. Using an external repository allows you to specify configuration options for multiple repositories in a single place. When you reference a configuration file located in an external repository, you can use the _OWNER/REPOSITORY/FILENAME@BRANCH_ syntax. For example, _monacorp/shared/codeql-config.yml@main_. diff --git a/data/reusables/code-scanning/run-additional-queries.md b/data/reusables/code-scanning/run-additional-queries.md index acc2be78d13c..c6783f7b9786 100644 --- a/data/reusables/code-scanning/run-additional-queries.md +++ b/data/reusables/code-scanning/run-additional-queries.md @@ -1,9 +1,9 @@ When you use {% data variables.product.prodname_codeql %} to scan code, the {% data variables.product.prodname_codeql %} analysis engine generates a database from the code and runs queries on it. For more information, see "[About {% data variables.product.prodname_code_scanning %}](/github/finding-security-vulnerabilities-and-errors-in-your-code/about-code-scanning#about-codeql)." -{% data variables.product.prodname_codeql %} analysis uses a default set of queries, but you can specify more queries to run, in addition to the default queries. The queries you want to run must belong to a {% data variables.product.prodname_ql %} pack and can be in your own repository or any public repository. For more information, see "[About {% data variables.product.prodname_ql %} packs](https://help.semmle.com/codeql/codeql-cli/reference/qlpack-overview.html)." +{% data variables.product.prodname_codeql %} analysis uses a default set of queries, but you can specify more queries to run, in addition to the default queries. The queries you want to run must belong to a {% data variables.product.prodname_ql %} pack in a repository. For more information, see "[About {% data variables.product.prodname_ql %} packs](https://codeql.github.com/docs/codeql-cli/about-ql-packs/)." -Queries must only depend on the standard libraries (that is, the libraries referenced by an `import LANGUAGE` statement in your query), or libraries in the same {% data variables.product.prodname_ql %} pack as the query. The standard libraries are located in the [github/codeql](https://github.com/github/codeql) repository. For more information, see "[About CodeQL queries](https://help.semmle.com/QL/learn-ql/writing-queries/introduction-to-queries.html)." +Queries must only depend on the standard libraries (that is, the libraries referenced by an `import LANGUAGE` statement in your query), or libraries in the same {% data variables.product.prodname_ql %} pack as the query. The standard libraries are located in the [github/codeql](https://github.com/github/codeql) repository. For more information, see "[About CodeQL queries](https://codeql.github.com/docs/writing-codeql-queries/about-codeql-queries/)." -You can specify a single _.ql_ file, a directory containing multiple _.ql_ files, a _.qls_ query suite definition file, or any combination. For more information about query suite definitions, see "[Creating {% data variables.product.prodname_codeql %} query suites](https://help.semmle.com/codeql/codeql-cli/procedures/query-suites.html)." +You can specify a single _.ql_ file, a directory containing multiple _.ql_ files, a _.qls_ query suite definition file, or any combination. For more information about query suite definitions, see "[Creating {% data variables.product.prodname_codeql %} query suites](https://codeql.github.com/docs/codeql-cli/creating-codeql-query-suites/)." {% if currentVersion == "free-pro-team@latest" %}We don't recommend referencing query suites directly from the `github/codeql` repository, like `github/codeql/cpp/ql/src@main`. Such queries may not be compiled with the same version of {% data variables.product.prodname_codeql %} as used for your other queries, which could lead to errors during analysis.{% endif %} diff --git a/data/reusables/dependabot/supported-package-managers.md b/data/reusables/dependabot/supported-package-managers.md index a7d2510f9d33..6369d25a7559 100644 --- a/data/reusables/dependabot/supported-package-managers.md +++ b/data/reusables/dependabot/supported-package-managers.md @@ -15,10 +15,10 @@ Elm | `elm` | v0.18, v0.19 | **✓** | | git submodule | `gitsubmodule` | N/A (no version) | **✓** | | GitHub Actions | `github-actions` | N/A (no version) | **✓** | | Go modules | `gomod` | v1 | **✓** | **✓** | -Gradle | `gradle` | see (A) below | **✓** | | -Maven | `maven` | see (B) below | **✓** | | +Gradle | `gradle` | N/A (no version)[1] | **✓** | | +Maven | `maven` | N/A (no version)[2] | **✓** | | npm | `npm` | v6, v7 | **✓** | | -NuGet | `nuget` | <= 4.8.
see (C) below | **✓** | | +NuGet | `nuget` | <= 4.8[3] | **✓** | | pip | `pip` | v20 | | | pipenv | `pip` | <= 2018.11.26 | | | pip-compile | `pip` | 5.5.0 | | | @@ -26,10 +26,10 @@ poetry | `pip` | v1 | | | Terraform | `terraform` | <= 0.11 | **✓** | | yarn | `npm` | v1 | **✓** | | -(A) {% data variables.product.prodname_dependabot %} doesn't run Gradle but supports updates to the following files: `build.gradle` and `build.gradle.kts` (for Kotlin projects). +[1] {% data variables.product.prodname_dependabot %} doesn't run Gradle but supports updates to the following files: `build.gradle` and `build.gradle.kts` (for Kotlin projects). -(B) {% data variables.product.prodname_dependabot %} doesn't run Maven but supports updates to `pom.xml` files. +[2] {% data variables.product.prodname_dependabot %} doesn't run Maven but supports updates to `pom.xml` files. -(C) {% data variables.product.prodname_dependabot %} doesn't run the NuGet CLI but does support most features up until version 4.8. +[3] {% data variables.product.prodname_dependabot %} doesn't run the NuGet CLI but does support most features up until version 4.8. For package managers such as `pipenv` and `poetry`, you need to use the `pip` YAML value. For example, if you use `poetry` to manage your Python dependencies and want {% data variables.product.prodname_dependabot %} to monitor your dependency manifest file for new versions, use `package-ecosystem: "pip"` in your *dependabot.yml* file. diff --git a/data/reusables/desktop/click-changed-files-header.md b/data/reusables/desktop/click-changed-files-header.md new file mode 100644 index 000000000000..ddd2e675db97 --- /dev/null +++ b/data/reusables/desktop/click-changed-files-header.md @@ -0,0 +1,13 @@ +1. Right click the **changed files** header. + + {% mac %} + + ![The changed files header](/assets/images/help/desktop/mac-changed-file-header.png) + + {% endmac %} + + {% windows %} + + ![The changed files header](/assets/images/help/desktop/windows-changed-file-header.png) + + {% endwindows %} \ No newline at end of file diff --git a/data/reusables/desktop/click-discard.md b/data/reusables/desktop/click-discard.md new file mode 100644 index 000000000000..95b253fef3ea --- /dev/null +++ b/data/reusables/desktop/click-discard.md @@ -0,0 +1,13 @@ +1. Click **Discard**. + + {% mac %} + + ![Discard stashed changes button](/assets/images/help/desktop/mac-discard-stashed-changes-button.png) + + {% endmac %} + + {% windows %} + + ![Discard stashed changes button](/assets/images/help/desktop/windows-discard-stashed-changes-button.png) + + {% endwindows %} diff --git a/data/reusables/desktop/click-restore.md b/data/reusables/desktop/click-restore.md new file mode 100644 index 000000000000..ce7cbdfc9cdb --- /dev/null +++ b/data/reusables/desktop/click-restore.md @@ -0,0 +1,13 @@ +1. Click **Restore**. + + {% mac %} + + ![Restore stashed changes button](/assets/images/help/desktop/mac-restore-stashed-changes-button.png) + + {% endmac %} + + {% windows %} + + ![Restore stashed changes button](/assets/images/help/desktop/windows-restore-stashed-changes-button.png) + + {% endwindows %} diff --git a/data/reusables/desktop/click-stash-all-changes.md b/data/reusables/desktop/click-stash-all-changes.md new file mode 100644 index 000000000000..deab24f2012e --- /dev/null +++ b/data/reusables/desktop/click-stash-all-changes.md @@ -0,0 +1,13 @@ +1. Click **Stash All Changes**. + + {% mac %} + + ![The Stash All Changes menu item](/assets/images/help/desktop/mac-stash-all-changes.png) + + {% endmac %} + + {% windows %} + + ![The Stash all changes menu item](/assets/images/help/desktop/windows-stash-all-changes.png) + + {% endwindows %} \ No newline at end of file diff --git a/data/reusables/desktop/click-stashed-changes.md b/data/reusables/desktop/click-stashed-changes.md new file mode 100644 index 000000000000..b2c82378c4ba --- /dev/null +++ b/data/reusables/desktop/click-stashed-changes.md @@ -0,0 +1,2 @@ +1. In the left sidebar, click **Stashed Changes**. + ![Stashed changes option](/assets/images/help/desktop/stashed-changes.png) \ No newline at end of file diff --git a/data/reusables/desktop/navigate-to-stashed-changes.md b/data/reusables/desktop/navigate-to-stashed-changes.md new file mode 100644 index 000000000000..9980422ed5f2 --- /dev/null +++ b/data/reusables/desktop/navigate-to-stashed-changes.md @@ -0,0 +1,2 @@ +1. If you are not already on the branch where the changes are stashed, click {% octicon "git-branch" aria-label="The branch icon" %} **Current Branch**, then click the branch with stashed changes. + ![List of branches in the repository](/assets/images/help/desktop/click-branch-in-drop-down-mac.png) \ No newline at end of file diff --git a/data/reusables/enterprise-accounts/email-tab.md b/data/reusables/enterprise-accounts/email-tab.md new file mode 100644 index 000000000000..c00994a9ed39 --- /dev/null +++ b/data/reusables/enterprise-accounts/email-tab.md @@ -0,0 +1,2 @@ +1. Under {% octicon "gear" aria-label="The Settings gear" %} **Settings**, click **Email**. + ![Email tab in the enterprise account sidebar](/assets/images/enterprise/configuration/enterprise-account-email-tab.png) diff --git a/data/reusables/files/choose-commit-email.md b/data/reusables/files/choose-commit-email.md index bd6dd6329704..d92bbe1813b4 100644 --- a/data/reusables/files/choose-commit-email.md +++ b/data/reusables/files/choose-commit-email.md @@ -1,4 +1,4 @@ {% if currentVersion == "free-pro-team@latest" %} -1. Below the commit message fields, click the email address drop-down menu and choose a Git author email address. Only verified email addresses appear in this drop-down menu. If you enabled email address privacy, then `@users.noreply.github.com` is the default commit author email address. For more information, see "[Setting your commit email address](/articles/setting-your-commit-email-address)." +1. If you have more than one email address associated with your {% data variables.product.product_name %} account, click the email address drop-down menu and select the email address to use as the Git author email address. Only verified email addresses appear in this drop-down menu. If you enabled email address privacy, then `@users.noreply.github.com` is the default commit author email address. For more information, see "[Setting your commit email address](/articles/setting-your-commit-email-address)." ![Choose commit email addresses](/assets/images/help/repository/choose-commit-email-address.png) {% endif %} diff --git a/data/reusables/gated-features/actions-shared.md b/data/reusables/gated-features/actions-shared.md index 57b1ab7a7d9f..d5bceb9ab191 100644 --- a/data/reusables/gated-features/actions-shared.md +++ b/data/reusables/gated-features/actions-shared.md @@ -1 +1 @@ -{% data variables.product.prodname_actions %} is available with {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_free_team %} for organizations, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %}, and {% data variables.product.prodname_ghe_one %}. {% data variables.product.prodname_actions %} is not available for private repositories owned by accounts using legacy per-repository plans. +{% data variables.product.prodname_actions %} is available with {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_free_team %} for organizations, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %}, {% data variables.product.prodname_ghe_one %}, and {% data variables.product.prodname_ghe_managed %}. {% data variables.product.prodname_actions %} is not available for private repositories owned by accounts using legacy per-repository plans. diff --git a/data/reusables/gated-features/allowed-ip-addresses.md b/data/reusables/gated-features/allowed-ip-addresses.md index 501edab172e6..b96ddd2ecfef 100644 --- a/data/reusables/gated-features/allowed-ip-addresses.md +++ b/data/reusables/gated-features/allowed-ip-addresses.md @@ -1 +1 @@ -Allowed IP addresses are available with {% data variables.product.prodname_ghe_cloud %}. For more information, see "[{% data variables.product.prodname_dotcom %}'s products](/articles/github-s-products)." +Allowed IP addresses are available with {% data variables.product.prodname_ghe_cloud %} and {% data variables.product.prodname_ghe_managed %}. For more information, see "[{% data variables.product.prodname_dotcom %}'s products](/articles/github-s-products)." diff --git a/data/reusables/gated-features/code-scanning.md b/data/reusables/gated-features/code-scanning.md index 35598cce5476..775fa282568a 100644 --- a/data/reusables/gated-features/code-scanning.md +++ b/data/reusables/gated-features/code-scanning.md @@ -1,4 +1,6 @@ {% if currentVersion == "free-pro-team@latest" %}{% data variables.product.prodname_code_scanning_capc %} is available for all public repositories and for private repositories owned by organizations where {% data variables.product.prodname_GH_advanced_security %} is enabled. {%- elsif currentVersion ver_gt "enterprise-server@3.0" %}{% data variables.product.prodname_code_scanning_capc %} is available if {% data variables.product.prodname_GH_advanced_security %} is enabled for the repository. +{%- elsif currentVersion == "github-ae@latest" %} +{% data variables.product.prodname_code_scanning_capc %} is available as part of {% data variables.product.prodname_GH_advanced_security %}, which is free during the beta release. {%- else %} {% data variables.product.prodname_code_scanning_capc %} is available if you have a license for {% data variables.product.prodname_GH_advanced_security %}.{% endif %} {% data reusables.advanced-security.more-info-ghas %} diff --git a/data/reusables/gated-features/okta-team-sync.md b/data/reusables/gated-features/okta-team-sync.md index 6c7ea925c520..8679234bec92 100644 --- a/data/reusables/gated-features/okta-team-sync.md +++ b/data/reusables/gated-features/okta-team-sync.md @@ -1,5 +1,9 @@ +{% if currentVersion != "github-ae@latest" %} + {% note %} **Note:** Team synchronization with Okta is currently in beta and subject to change. {% endnote %} + +{% endif %} diff --git a/data/reusables/gated-features/packages.md b/data/reusables/gated-features/packages.md index 7abac09055c9..e0cfb660456d 100644 --- a/data/reusables/gated-features/packages.md +++ b/data/reusables/gated-features/packages.md @@ -1,4 +1,4 @@ -{% data variables.product.prodname_registry %} is available with {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_free_team %} for organizations, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %} 2.22, and {% data variables.product.prodname_ghe_one %}. +{% data variables.product.prodname_registry %} is available with {% data variables.product.prodname_free_user %}, {% data variables.product.prodname_pro %}, {% data variables.product.prodname_free_team %} for organizations, {% data variables.product.prodname_team %}, {% data variables.product.prodname_ghe_cloud %}, {% data variables.product.prodname_ghe_server %} 2.22, {% data variables.product.prodname_ghe_one %}, and {% data variables.product.prodname_ghe_managed %}. {% if currentVersion == "free-pro-team@latest" %}
{% data variables.product.prodname_registry %} is not available for private repositories owned by accounts using legacy per-repository plans. Also, accounts using legacy per-repository plans cannot access {% data variables.product.prodname_github_container_registry %} since these accounts are billed by repository. {% data reusables.gated-features.more-info %} {% endif %} diff --git a/data/reusables/gated-features/secret-scanning.md b/data/reusables/gated-features/secret-scanning.md index 7396ad8e2414..f67bcdf4e464 100644 --- a/data/reusables/gated-features/secret-scanning.md +++ b/data/reusables/gated-features/secret-scanning.md @@ -1 +1,7 @@ +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} {% data variables.product.prodname_secret_scanning_caps %} is available {% if currentVersion == "free-pro-team@latest" %}in public repositories, and in private repositories owned by organizations with {% else %}if you have {% endif %}an {% data variables.product.prodname_advanced_security %} license. {% data reusables.advanced-security.more-info-ghas %} +{% endif %} + +{% if currentVersion == "github-ae@latest" %} +{% data variables.product.prodname_secret_scanning_caps %} is available as part of {% data variables.product.prodname_GH_advanced_security %}, which is free during the beta release. +{% endif %} \ No newline at end of file diff --git a/data/reusables/gated-features/team-synchronization.md b/data/reusables/gated-features/team-synchronization.md index 896fbab1d6e3..0851c08049e9 100644 --- a/data/reusables/gated-features/team-synchronization.md +++ b/data/reusables/gated-features/team-synchronization.md @@ -1 +1 @@ -Team synchronization is available for organizations and enterprise accounts using {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info-org-products %} +{% if currentVersion == "free-pro-team@latest" %}Team synchronization is available for organizations and enterprise accounts using {% data variables.product.prodname_ghe_cloud %}. {% data reusables.gated-features.more-info-org-products %}{% elsif currentVersion == "github-ae@latest" %}Synchronization of teams with SCIM groups is available for organizations using {% data variables.product.prodname_ghe_managed %}. For more information, see "[GitHub's products](/github/getting-started-with-github/githubs-products)."{% endif %} diff --git a/data/reusables/github-actions/artifact-log-retention-statement.md b/data/reusables/github-actions/artifact-log-retention-statement.md index 00249ec8d5ae..badcea5006b5 100644 --- a/data/reusables/github-actions/artifact-log-retention-statement.md +++ b/data/reusables/github-actions/artifact-log-retention-statement.md @@ -1,2 +1,2 @@ -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and this retention period can be customized. For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#artifact-and-log-retention-policy)".{% endif %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} By default, {% data variables.product.product_name %} stores build logs and artifacts for 90 days, and this retention period can be customized. For more information, see "[Usage limits, billing, and administration](/actions/reference/usage-limits-billing-and-administration#artifact-and-log-retention-policy)".{% endif %} {% if currentVersion == "enterprise-server@2.22" %} {% data variables.product.product_name %} stores full build logs and artifacts for 90 days.{% endif %} diff --git a/data/reusables/github-actions/disabling-github-actions.md b/data/reusables/github-actions/disabling-github-actions.md index 56bbb36beec0..0481ab8bab06 100644 --- a/data/reusables/github-actions/disabling-github-actions.md +++ b/data/reusables/github-actions/disabling-github-actions.md @@ -1 +1 @@ -By default, {% if currentVersion ver_gt "enterprise-server@2.21" %}after {% data variables.product.prodname_actions %} is enabled on {% data variables.product.product_location %}, it{% elsif currentVersion == "free-pro-team@latest" %}{% data variables.product.prodname_actions %}{% endif %} is enabled on all repositories and organizations. You can choose to disable {% data variables.product.prodname_actions %} or limit them to private actions only, which means that people can only use actions that exist in your repository. +By default, {% if currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}after {% data variables.product.prodname_actions %} is enabled on {% data variables.product.product_location %}, it{% elsif currentVersion == "free-pro-team@latest" %}{% data variables.product.prodname_actions %}{% endif %} is enabled on all repositories and organizations. You can choose to disable {% data variables.product.prodname_actions %} or limit them to private actions only, which means that people can only use actions that exist in your repository. diff --git a/data/reusables/github-actions/expression-syntax-if.md b/data/reusables/github-actions/expression-syntax-if.md index 69549fd112ee..70a79eb94fd0 100644 --- a/data/reusables/github-actions/expression-syntax-if.md +++ b/data/reusables/github-actions/expression-syntax-if.md @@ -1 +1 @@ -When you use expressions in an `if` conditional, you may omit the expression syntax ({% raw %}`${{ }}`{% endraw %}) because {% data variables.product.prodname_dotcom %} automatically evaluates the `if` conditional as an expression. +When you use expressions in an `if` conditional, you may omit the expression syntax ({% raw %}`${{ }}`{% endraw %}) because {% data variables.product.prodname_dotcom %} automatically evaluates the `if` conditional as an expression, unless the expression contains any operators. If the expression contains any operators, the expression must be contained within {% raw %}`${{ }}`{% endraw %} to explicitly mark it for evaluation. diff --git a/data/reusables/github-actions/hosted-runner-configure-runner-group-access.md b/data/reusables/github-actions/hosted-runner-configure-runner-group-access.md new file mode 100644 index 000000000000..1546336d056d --- /dev/null +++ b/data/reusables/github-actions/hosted-runner-configure-runner-group-access.md @@ -0,0 +1,2 @@ +1. In the runner section of the settings page, click {% octicon "kebab-horizontal" aria-label="The horizontal kebab icon" %} next to the runner group you'd like to configure, then click **Edit name and [organization|repository] access**. +1. Modify your policy options, or change the runner group name. diff --git a/data/reusables/github-actions/hosted-runner-labels-view-assigned-labels.md b/data/reusables/github-actions/hosted-runner-labels-view-assigned-labels.md new file mode 100644 index 000000000000..a070ec7fb977 --- /dev/null +++ b/data/reusables/github-actions/hosted-runner-labels-view-assigned-labels.md @@ -0,0 +1,3 @@ +1. Locate the runner you want to update, and click {% octicon "triangle-down" aria-label="The downward triangle" %} to view the label selection menu. This menu displays all the custom labels available to your runner. Labels already assigned to your runner have a {% octicon "check" aria-label="Check mark" %} next to them. + + ![Change runner label](/assets/images/help/settings/actions-hosted-runner-list-label.png) diff --git a/data/reusables/github-actions/hosted-runner-list-group.md b/data/reusables/github-actions/hosted-runner-list-group.md new file mode 100644 index 000000000000..932c3059f244 --- /dev/null +++ b/data/reusables/github-actions/hosted-runner-list-group.md @@ -0,0 +1,3 @@ +1. If your runner is in a group, locate the runner group and click {% octicon "chevron-down" aria-label="The downward chevron" %} to view the list of runners. + + ![List runner group](/assets/images/help/settings/actions-hosted-runner-group-members.png) diff --git a/data/reusables/github-actions/hosted-runner-list.md b/data/reusables/github-actions/hosted-runner-list.md new file mode 100644 index 000000000000..9b5de7045f5a --- /dev/null +++ b/data/reusables/github-actions/hosted-runner-list.md @@ -0,0 +1 @@ +1. Click the "Self-hosted runners" tab, and locate the list of runners. diff --git a/data/reusables/github-actions/hosted-runner-navigate-to-repo-org-enterprise.md b/data/reusables/github-actions/hosted-runner-navigate-to-repo-org-enterprise.md new file mode 100644 index 000000000000..ae17dc7e2ebf --- /dev/null +++ b/data/reusables/github-actions/hosted-runner-navigate-to-repo-org-enterprise.md @@ -0,0 +1,15 @@ +1. Navigate to where your {% data variables.actions.hosted_runner %} is registered: + * **In an organization or repository**: navigate to the main page and click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. + * **If using an enterprise-level runner**: + + 1. In the upper-right corner of any page, click {% octicon "rocket" aria-label="The rocket ship" %}. + 1. In the left sidebar, click **Enterprise overview**. + 1. In the enterprise sidebar, click {% octicon "law" aria-label="The law icon" %} **Policies**. +1. Navigate to the {% data variables.product.prodname_actions %} settings: + * **In an organization or repository**: Click **Actions** in the left sidebar. + + ![Actions setting](/assets/images/help/settings/settings-sidebar-actions.png) + * **If using an enterprise-level runner**: Under "{% octicon "law" aria-label="The law icon" %} Policies", click **Actions**. + + ![Actions setting](/assets/images/help/settings/actions-enterprise-policies.png) + diff --git a/data/reusables/github-actions/ip-allow-list-hosted-runners.md b/data/reusables/github-actions/ip-allow-list-hosted-runners.md new file mode 100644 index 000000000000..caa664045e6e --- /dev/null +++ b/data/reusables/github-actions/ip-allow-list-hosted-runners.md @@ -0,0 +1,3 @@ +To allow your {% data variables.actions.hosted_runner %}s to communicate with {% data variables.product.prodname_dotcom %}, add the IP address or IP address range of your {% data variables.actions.hosted_runner %}s to the IP allow list. For more information, see "[Adding an allowed IP address](#adding-an-allowed-ip-address)." + +For more information about {% data variables.actions.hosted_runner %}s, see "[About {% data variables.actions.hosted_runner %}s](/github-ae@latest/actions/using-github-hosted-runners/about-ae-hosted-runners)." diff --git a/data/reusables/github-actions/ip-allow-list-self-hosted-runners.md b/data/reusables/github-actions/ip-allow-list-self-hosted-runners.md index 95bc1896b9e9..f24c38c911e8 100644 --- a/data/reusables/github-actions/ip-allow-list-self-hosted-runners.md +++ b/data/reusables/github-actions/ip-allow-list-self-hosted-runners.md @@ -1,3 +1,6 @@ +{% if currentVersion == "github-ae@latest" %} +To allow your {% data variables.actions.hosted_runner %}s to communicate with {% data variables.product.prodname_dotcom %}, add the IP address or IP address range of your {% data variables.actions.hosted_runner %}s to the IP allow list. For more information, see "[Adding an allowed IP address](#adding-an-allowed-ip-address)." +{% else %} {% warning %} **Warning**: If you use an IP allow list and would also like to use {% data variables.product.prodname_actions %}, you must use self-hosted runners. For more information, see "[Hosting your own runners](/actions/automating-your-workflow-with-github-actions/about-self-hosted-runners)." @@ -5,3 +8,4 @@ {% endwarning %} To allow your self-hosted runners to communicate with {% data variables.product.prodname_dotcom %}, add the IP address or IP address range of your self-hosted runners to the IP allow list. For more information, see "[Adding an allowed IP address](#adding-an-allowed-ip-address)." +{% endif %} diff --git a/data/reusables/github-actions/self-hosted-runner-management-permissions-required.md b/data/reusables/github-actions/self-hosted-runner-management-permissions-required.md index 9ddc7c7b5c24..bb9771716070 100644 --- a/data/reusables/github-actions/self-hosted-runner-management-permissions-required.md +++ b/data/reusables/github-actions/self-hosted-runner-management-permissions-required.md @@ -1,9 +1,9 @@ -A self-hosted runner can be located in either your repository, organization, or {% if currentVersion == "free-pro-team@latest" %}enterprise account settings on {% data variables.product.prodname_dotcom %}{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %} enterprise settings on {% data variables.product.product_location %}{% endif %}. To manage a self-hosted runner, you must have the following permissions, depending on where the self-hosted runner was added: +A self-hosted runner can be located in either your repository, organization, or {% if currentVersion == "free-pro-team@latest" %}enterprise account settings on {% data variables.product.prodname_dotcom %}{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} enterprise settings on {% data variables.product.product_location %}{% endif %}. To manage a self-hosted runner, you must have the following permissions, depending on where the self-hosted runner was added: - **User repository**: You must be the repository owner. - **Organization**: You must be an organization owner. - **Organization repository**: You must be an organization owner, or have admin access to the repository. {% if currentVersion == "free-pro-team@latest" %} - **Enterprise account**: You must be an enterprise owner. -{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %} +{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} - **Enterprise**: You must be a {% data variables.product.prodname_enterprise %} site administrator. {% endif %} diff --git a/data/reusables/github-actions/self-hosted-runner-navigate-to-repo-org-enterprise.md b/data/reusables/github-actions/self-hosted-runner-navigate-to-repo-org-enterprise.md index 12756c93a00f..313c117a3ebe 100644 --- a/data/reusables/github-actions/self-hosted-runner-navigate-to-repo-org-enterprise.md +++ b/data/reusables/github-actions/self-hosted-runner-navigate-to-repo-org-enterprise.md @@ -1,6 +1,6 @@ 1. Navigate to where your self-hosted runner is registered: * **In an organization or repository**: navigate to the main page and click {% octicon "gear" aria-label="The Settings gear" %} **Settings**. - * {% if currentVersion == "free-pro-team@latest" %}**If using an enterprise account**: navigate to your enterprise account by visiting `https://github.com/enterprises/ENTERPRISE-NAME`, replacing `ENTERPRISE-NAME` with your enterprise account's name.{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}**If using an enterprise-level runner**: + * {% if currentVersion == "free-pro-team@latest" %}**If using an enterprise account**: navigate to your enterprise account by visiting `https://github.com/enterprises/ENTERPRISE-NAME`, replacing `ENTERPRISE-NAME` with your enterprise account's name.{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}**If using an enterprise-level runner**: 1. In the upper-right corner of any page, click {% octicon "rocket" aria-label="The rocket ship" %}. 1. In the left sidebar, click **Enterprise overview**. @@ -9,4 +9,4 @@ * **In an organization or repository**: click **Actions** in the left sidebar. ![Actions setting](/assets/images/help/settings/settings-sidebar-actions.png) - * {% if currentVersion == "free-pro-team@latest" %}**If using an enterprise account**{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" %}**If using an enterprise-level runner**{% endif %}: click **Actions** under "{% octicon "law" aria-label="The law icon" %} Policies". + * {% if currentVersion == "free-pro-team@latest" %}**If using an enterprise account**{% elsif enterpriseServerVersions contains currentVersion and currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %}**If using an enterprise-level runner**{% endif %}: click **Actions** under "{% octicon "law" aria-label="The law icon" %} Policies". diff --git a/data/reusables/github-actions/self-hosted-runner-security.md b/data/reusables/github-actions/self-hosted-runner-security.md index 446a9ca1db61..0d4c1556b1bb 100644 --- a/data/reusables/github-actions/self-hosted-runner-security.md +++ b/data/reusables/github-actions/self-hosted-runner-security.md @@ -1,3 +1 @@ -We recommend that you do not use self-hosted runners with public repositories. - -Forks of your public repository can potentially run dangerous code on your self-hosted runner machine by creating a pull request that executes the code in a workflow. +We recommend that you only use self-hosted runners with private repositories. This is because forks of your repository can potentially run dangerous code on your self-hosted runner machine by creating a pull request that executes the code in a workflow. diff --git a/data/reusables/github-ae/github-ae-enables-you.md b/data/reusables/github-ae/github-ae-enables-you.md index dd699d9ad63f..b7adad1f4649 100644 --- a/data/reusables/github-ae/github-ae-enables-you.md +++ b/data/reusables/github-ae/github-ae-enables-you.md @@ -1 +1 @@ -{% data variables.product.prodname_ghe_managed %} enables you to move your software development to the cloud while meeting the most stringent security and compliance requirements. +{% data variables.product.prodname_ghe_managed %} enables you to move your DevOps workload to the cloud while meeting stringent security and compliance requirements. diff --git a/data/reusables/organizations/invite_to_org.md b/data/reusables/organizations/invite_to_org.md index e20170e43d2c..dd528442c25c 100644 --- a/data/reusables/organizations/invite_to_org.md +++ b/data/reusables/organizations/invite_to_org.md @@ -1,4 +1,4 @@ {% if currentVersion == "free-pro-team@latest" %}1. Type the username, full name, or email address of the person you want to invite and click **Invite**. ![Invite member form](/assets/images/help/organizations/org-invite-modal.png){% else %} 1. Type the username, full name, or email address of the person you want to add and click **Invite**. - ![Invite member form](/assets/images/help/organizations/org-invite-modal-ghe.png){% endif %} + ![Invite member form](/assets/images/help/organizations/org-invite-modal.png){% endif %} diff --git a/data/reusables/organizations/security.md b/data/reusables/organizations/security.md index e8bb0ed5d76d..a29659283cd1 100644 --- a/data/reusables/organizations/security.md +++ b/data/reusables/organizations/security.md @@ -1,7 +1,6 @@ {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" or currentVersion == "github-ae@latest" %} 1. In the left sidebar, click **Organization security**. - ![Organization security settings](/assets/images/help/organizations/org-security-settings-tab.png) {% else %} 1. In the left sidebar, click **Security**. - ![Organization security settings](/assets/images/help/organizations/org-settings-security-tab.png) {% endif %} + ![Organization security settings](/assets/images/help/organizations/org-security-settings-tab.png) \ No newline at end of file diff --git a/data/reusables/organizations/team-synchronization.md b/data/reusables/organizations/team-synchronization.md index 121340e06b00..a609ef11b9cd 100644 --- a/data/reusables/organizations/team-synchronization.md +++ b/data/reusables/organizations/team-synchronization.md @@ -1,3 +1,3 @@ -{% if currentVersion == "free-pro-team@latest" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion == "github-ae@latest" %} You can use team synchronization to automatically add and remove organization members to teams through an identity provider. For more information, see "[Synchronizing a team with an identity provider group](/github/setting-up-and-managing-organizations-and-teams/synchronizing-a-team-with-an-identity-provider-group)." {% endif %} diff --git a/data/reusables/package_registry/apache-maven-snapshot-versions-supported.md b/data/reusables/package_registry/apache-maven-snapshot-versions-supported.md index b26c0fb5d693..8728373612c1 100644 --- a/data/reusables/package_registry/apache-maven-snapshot-versions-supported.md +++ b/data/reusables/package_registry/apache-maven-snapshot-versions-supported.md @@ -1 +1 @@ -{% data variables.product.prodname_registry %} supports `SNAPSHOT` versions of Apache Maven. To use a repository for downloading this type of artifact, you must enable SNAPSHOTS in your *~/.m2/settings.xml* file. +{% data variables.product.prodname_registry %} supports `SNAPSHOT` versions of Apache Maven. To use the {% data variables.product.prodname_registry %} repository for downloading `SNAPSHOT` artifacts, enable SNAPSHOTS in the POM of the consuming project or your *~/.m2/settings.xml* file. diff --git a/data/reusables/package_registry/docker_registry_deprecation_status.md b/data/reusables/package_registry/docker_registry_deprecation_status.md index a23fdc598bc1..73a07a040b12 100644 --- a/data/reusables/package_registry/docker_registry_deprecation_status.md +++ b/data/reusables/package_registry/docker_registry_deprecation_status.md @@ -1,5 +1,5 @@ {% warning %} -**Note:** The {% data variables.product.prodname_registry %} Docker registry will be superseded by {% data variables.product.prodname_github_container_registry %}{% if enterpriseServerVersions contains currentVersion %} in a future {% data variables.product.product_name %} release{% endif %}.{% if currentVersion == "free-pro-team@latest" %} To learn how to migrate your existing Docker images and any workflows using them, see "[Migrating to {% data variables.product.prodname_github_container_registry %} for Docker images](/packages/guides/migrating-to-github-container-registry-for-docker-images)" and "[Container guides for {% data variables.product.prodname_registry %}](/packages/guides/container-guides-for-github-packages)."{% endif %} +**Note:** The {% data variables.product.prodname_registry %} Docker registry {% if enterpriseServerVersions contains currentVersion or currentVersion == "github-ae@latest" %} will offer improved container support in a future {% data variables.product.product_name %} release.{% elsif currentVersion == "free-pro-team@latest" %} now offers improved container support. For more information, see "[About GitHub Container Registry](/packages/guides/about-github-container-registry)." To learn how to migrate your existing Docker images and any workflows using them, see "[Migrating to {% data variables.product.prodname_github_container_registry %} for Docker images](/packages/guides/migrating-to-github-container-registry-for-docker-images)" and "[Container guides for {% data variables.product.prodname_registry %}](/packages/guides/container-guides-for-github-packages)."{% endif %} {% endwarning %} diff --git a/data/reusables/package_registry/packages-ghae-release-stage.md b/data/reusables/package_registry/packages-ghae-release-stage.md new file mode 100644 index 000000000000..1fa479c335c4 --- /dev/null +++ b/data/reusables/package_registry/packages-ghae-release-stage.md @@ -0,0 +1,7 @@ +{% if currentVersion == "github-ae@latest" %} +{% note %} + +**Note:** {% data variables.product.prodname_registry %} is currently in beta for {% data variables.product.prodname_ghe_managed %}. + +{% endnote %} +{% endif %} diff --git a/data/reusables/package_registry/packages-ghes-release-stage.md b/data/reusables/package_registry/packages-ghes-release-stage.md index 04e4ffd9ea45..3d3510d9b805 100644 --- a/data/reusables/package_registry/packages-ghes-release-stage.md +++ b/data/reusables/package_registry/packages-ghes-release-stage.md @@ -1,7 +1,7 @@ {% if currentVersion == "enterprise-server@2.22" %} {% note %} -**Note:** {% data variables.product.prodname_registry %} is currently in beta for {% data variables.product.prodname_ghe_server %} 2.22. To join the beta for your {% data variables.product.product_location %}, use the [sign-up form](https://resources.github.com/beta-signup/). +**Note:** {% data variables.product.prodname_registry %} is currently in beta for {% data variables.product.prodname_ghe_server %} 2.22. To join the beta for {% data variables.product.product_location %}, use the [sign-up form](https://resources.github.com/beta-signup/). {% endnote %} {% endif %} diff --git a/data/reusables/package_registry/public-or-private-packages.md b/data/reusables/package_registry/public-or-private-packages.md index 96876d84f347..2838a5747068 100644 --- a/data/reusables/package_registry/public-or-private-packages.md +++ b/data/reusables/package_registry/public-or-private-packages.md @@ -1 +1 @@ -You can publish packages in a public repository (public packages) to share with {% if currentVersion == "free-pro-team@latest" %}all of {% data variables.product.prodname_dotcom %}{% else %}everyone on your instance{% endif %}, or in a private repository (private packages) to share with collaborators or an organization. +You can publish packages in {% if currentVersion == "github-ae@latest" %}an internal{% else %}a public{% endif %} repository ({% if currentVersion == "github-ae@latest" %}internal{% else %}public{% endif %} packages) to share with {% if currentVersion == "free-pro-team@latest" %}all of {% data variables.product.prodname_dotcom %}{% else %}everyone on your enterprise{% endif %}, or in a private repository (private packages) to share with collaborators or an organization. diff --git a/data/reusables/secret-scanning/beta.md b/data/reusables/secret-scanning/beta.md index 82fdadded938..e0b230700bfb 100644 --- a/data/reusables/secret-scanning/beta.md +++ b/data/reusables/secret-scanning/beta.md @@ -1,7 +1,7 @@ -{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} {% note %} -**Note:** {% data variables.product.prodname_secret_scanning_caps %} for organization-owned{% if currentVersion ver_gt "enterprise-server@2.22" %} public and{% endif %} private repositories is currently in beta and subject to change. +**Note:** {% data variables.product.prodname_secret_scanning_caps %} for organization-owned{% if currentVersion == "free-pro-team@latest" %} private{% endif %} repositories is currently in beta and subject to change. {% endnote %} diff --git a/data/reusables/user-settings/oauth_apps.md b/data/reusables/user-settings/oauth_apps.md index ad5f4e71d60b..dca540647ba8 100644 --- a/data/reusables/user-settings/oauth_apps.md +++ b/data/reusables/user-settings/oauth_apps.md @@ -1,2 +1,2 @@ 1. In the left sidebar, click **OAuth Apps**. -![OAuth Apps section](/assets/images/settings/oauth_apps_post2dot12.png) +![OAuth Apps section](/assets/images/help/settings/developer-settings-oauth-apps.png) diff --git a/data/reusables/webhooks/check_run_properties.md b/data/reusables/webhooks/check_run_properties.md index eca6f57502af..15905ea4c69b 100644 --- a/data/reusables/webhooks/check_run_properties.md +++ b/data/reusables/webhooks/check_run_properties.md @@ -6,7 +6,7 @@ Key | Type | Description `check_run[conclusion]`|`string` | The result of the completed check run. Can be one of `success`, `failure`, `neutral`, `cancelled`, `timed_out`, {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.19" or currentVersion == "github-ae@latest" %}`action_required` or `stale`{% else %}or `action_required`{% endif %}. This value will be `null` until the check run has `completed`. `check_run[name]`|`string` | The name of the check run. `check_run[check_suite][id]`|`integer` | The id of the check suite that this check run is part of. -`check_run[check_suite][pull_requests]`|`array`| An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %} -`deployment`|`object`| A deployment to a repository environment. This will only be populated if the check run was created by a {% data variables.product.prodname_actions %} workflow job that references an environment.{% endif %} +`check_run[check_suite][pull_requests]`|`array`| An array of pull requests that match this check suite. A pull request matches a check suite if they have the same `head_sha` and `head_branch`. When the check suite's `head_branch` is in a forked repository it will be `null` and the `pull_requests` array will be empty.{% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %} +`check_run[check_suite][deployment]`|`object`| A deployment to a repository environment. This will only be populated if the check run was created by a {% data variables.product.prodname_actions %} workflow job that references an environment.{% endif %} `requested_action`|`object` | The action requested by the user. `requested_action[identifier]`|`string` | The integrator reference of the action requested by the user. diff --git a/data/reusables/webhooks/create_properties.md b/data/reusables/webhooks/create_properties.md index 4f876a59255c..23e8dcf25c36 100644 --- a/data/reusables/webhooks/create_properties.md +++ b/data/reusables/webhooks/create_properties.md @@ -2,5 +2,5 @@ Key | Type | Description ----|------|------------- `ref`|`string` | The [`git ref`](/rest/reference/git#get-a-reference) resource. `ref_type`|`string` | The type of Git ref object created in the repository. Can be either `branch` or `tag`. -`master_branch`|`string` | The name of the repository's default branch (usually {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.23" %}`main`{% else %}`master`{% endif %}). +`master_branch`|`string` | The name of the repository's default branch (usually {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.23" or currentVersion == "github-ae@latest" %}`main`{% else %}`master`{% endif %}). `description`|`string` | The repository's current description. diff --git a/data/reusables/webhooks/label_short_desc.md b/data/reusables/webhooks/label_short_desc.md index a634b7faa7a4..0f4041c4bb1f 100644 --- a/data/reusables/webhooks/label_short_desc.md +++ b/data/reusables/webhooks/label_short_desc.md @@ -1 +1 @@ -Activity related to an issue. {% data reusables.webhooks.action_type_desc %} For more information, see the "[labels](/rest/reference/issues#labels)" REST API. +Activity related to a label. {% data reusables.webhooks.action_type_desc %} For more information, see the "[labels](/rest/reference/issues#labels)" REST API. diff --git a/data/reusables/webhooks/pull_request_webhook_properties.md b/data/reusables/webhooks/pull_request_webhook_properties.md index ecd62db72799..1f6e268bdfd2 100644 --- a/data/reusables/webhooks/pull_request_webhook_properties.md +++ b/data/reusables/webhooks/pull_request_webhook_properties.md @@ -1,3 +1,3 @@ Key | Type | Description ----|------|------------- -`action`|`string` | The action that was performed. Can be one of `opened`, `edited`, `closed`, `assigned`, `unassigned`, `review_requested`, `review_request_removed`, `ready_for_review`, `converted_to_draft`, `labeled`, `unlabeled`, `synchronize`, {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" %}`auto_merge_enabled`, `auto_merge_disabled`,{% endif %} `locked`, `unlocked`, or `reopened`. If the action is `closed` and the `merged` key is `false`, the pull request was closed with unmerged commits. If the action is `closed` and the `merged` key is `true`, the pull request was merged. +`action`|`string` | The action that was performed. Can be one of `opened`, `edited`, `closed`, `assigned`, `unassigned`, `review_requested`, `review_request_removed`, `ready_for_review`, `converted_to_draft`, `labeled`, `unlabeled`, `synchronize`, {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@3.0" or currentVersion == "github-ae@latest" %}`auto_merge_enabled`, `auto_merge_disabled`,{% endif %} `locked`, `unlocked`, or `reopened`. If the action is `closed` and the `merged` key is `false`, the pull request was closed with unmerged commits. If the action is `closed` and the `merged` key is `true`, the pull request was merged. diff --git a/data/reusables/webhooks/secret.md b/data/reusables/webhooks/secret.md index a92e5fca87b5..95f3a341ca08 100644 --- a/data/reusables/webhooks/secret.md +++ b/data/reusables/webhooks/secret.md @@ -1 +1 @@ -Setting a webhook secret allows you to ensure that `POST` requests sent to the payload URL are from {% data variables.product.product_name %}. When you set a secret, you'll receive the {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}`X-Hub-Signature` and `X-Hub-Signature-256` headers{% elsif currentVersion ver_lt "enterprise-server@2.23" %}`X-Hub-Signature` header{% elsif currentVersion == "github-ae@latest" %}`X-Hub-Signature-256` header{% endif %} in the webhook `POST` request. For more information on how to use a secret with a signature header to secure your webhook payloads, see "[Securing your webhooks](/webhooks/securing/)." +Setting a webhook secret allows you to ensure that `POST` requests sent to the payload URL are from {% data variables.product.product_name %}. When you set a secret, you'll receive the {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}`X-Hub-Signature` and `X-Hub-Signature-256` headers{% elsif currentVersion ver_lt "enterprise-server@2.23" %}`X-Hub-Signature` header{% elsif currentVersion == "github-ae@latest" %}`X-Hub-Signature-256` header{% endif %} in the webhook `POST` request. For more information on how to use a secret with a signature header to secure your webhook payloads, see "[Securing your webhooks](/webhooks/securing/)." diff --git a/data/reusables/webhooks/webhooks-rest-api-links.md b/data/reusables/webhooks/webhooks-rest-api-links.md index 3882222b0545..1dd3383c2f95 100644 --- a/data/reusables/webhooks/webhooks-rest-api-links.md +++ b/data/reusables/webhooks/webhooks-rest-api-links.md @@ -1,4 +1,4 @@ -You can use the repository, organization, and app webhook REST APIs to create, update, delete, and ping webhooks. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %}You can also use the REST API to change the configuration of the webhook. For example, you can modify the payload URL, content type, SSL verification, and secret. {% endif %}For more information, see: +You can use the repository, organization, and app webhook REST APIs to create, update, delete, and ping webhooks. {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %}You can also use the REST API to change the configuration of the webhook. For example, you can modify the payload URL, content type, SSL verification, and secret. {% endif %}For more information, see: - [Repository Webhooks REST API](/rest/reference/repos#webhooks) -- [Organization Webhooks REST API](/rest/reference/orgs#webhooks){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" %} +- [Organization Webhooks REST API](/rest/reference/orgs#webhooks){% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.22" or currentVersion == "github-ae@latest" %} - [GitHub App Webhooks REST API](/rest/reference/apps#webhooks){% endif %} diff --git a/data/variables/actions.yml b/data/variables/actions.yml new file mode 100644 index 000000000000..35d247f2973b --- /dev/null +++ b/data/variables/actions.yml @@ -0,0 +1 @@ +hosted_runner: 'AE hosted runner' diff --git a/lib/enterprise-server-releases.js b/lib/enterprise-server-releases.js index 5d315fc511ae..3e6f83c31a5a 100644 --- a/lib/enterprise-server-releases.js +++ b/lib/enterprise-server-releases.js @@ -47,8 +47,8 @@ const nextDeprecationDate = dates[oldestSupported].deprecationDate const isOldestReleaseDeprecated = new Date() > new Date(nextDeprecationDate) const deprecatedOnNewSite = deprecated.filter(version => versionSatisfiesRange(version, '>=2.13')) const firstVersionDeprecatedOnNewSite = '2.13' -// starting from 2.18, we updated the archival script to create stubbed HTML redirect files -const lastVersionWithoutStubbedRedirectFiles = '2.17' +// starting from 2.18, we updated the archival script to create a redirects.json top-level file in the archived repo +const lastVersionWithoutArchivedRedirectsFile = '2.17' // last version using paths like /enterprise/////
// instead of /enterprise-server@///
const lastReleaseWithLegacyFormat = '2.18' @@ -68,7 +68,7 @@ module.exports = { deprecatedOnNewSite, dates, firstVersionDeprecatedOnNewSite, - lastVersionWithoutStubbedRedirectFiles, + lastVersionWithoutArchivedRedirectsFile, lastReleaseWithLegacyFormat, deprecatedReleasesWithLegacyFormat, deprecatedReleasesWithNewFormat, diff --git a/lib/graphql/static/changelog.json b/lib/graphql/static/changelog.json index 9d5002a4dff6..67d058d24575 100644 --- a/lib/graphql/static/changelog.json +++ b/lib/graphql/static/changelog.json @@ -1,4 +1,49 @@ [ + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "Field `isPinned` was added to object type `Issue`", + "Enum value 'CREATED_AT` was added to enum `VerifiableDomainOrderField'", + "Field `createdAt` was added to object type `VerifiableDomain`", + "Field `updatedAt` was added to object type `VerifiableDomain`" + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2021-03-03" + }, + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "Field `isGitHubStar` was added to object type `User`", + "Field `tagCommit` was added to object type `Release`" + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2021-03-02" + }, + { + "schemaChanges": [ + { + "title": "The GraphQL schema includes these changes:", + "changes": [ + "Type `ApproveVerifiableDomainInput` was added", + "Type `ApproveVerifiableDomainPayload` was added", + "Field `approveVerifiableDomain` was added to object type `Mutation`" + ] + } + ], + "previewChanges": [], + "upcomingChanges": [], + "date": "2021-02-25" + }, { "schemaChanges": [ { diff --git a/lib/graphql/static/prerendered-objects.json b/lib/graphql/static/prerendered-objects.json index cb9ad8d040c2..915e5f2c20ff 100644 --- a/lib/graphql/static/prerendered-objects.json +++ b/lib/graphql/static/prerendered-objects.json @@ -1,6 +1,6 @@ { "dotcom": { - "html": "
\n
\n

\n ActorLocation\n

\n

Location information for an actor.

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

Fields

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

city (String)

City.

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

country (String)

Country name.

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

countryCode (String)

Country code.

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

region (String)

Region name.

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

regionCode (String)

Region or state code.

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

\n AddedToProjectEvent\n

\n

Represents aadded_to_projectevent on a given issue or pull request.

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

\n \n \n\n \n

Fields

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

actor (Actor)

Identifies the actor who performed the event.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

databaseId (Int)

Identifies the primary key from the database.

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

project (Project)

Project referenced by event.

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

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

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

projectCard (ProjectCard)

Project card referenced by this project event.

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

Preview notice

\n

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

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

projectColumnName (String!)

Column name referenced by this project event.

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

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

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

\n App\n

\n

A GitHub App.

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

\n \n \n\n \n

Fields

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

databaseId (Int)

Identifies the primary key from the database.

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

description (String)

The description of the app.

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

logoBackgroundColor (String!)

The hex color code, without the leading '#', for the logo background.

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

logoUrl (URI!)

A URL pointing to the app's logo.

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

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting image.

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

name (String!)

The name of the app.

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

slug (String!)

A slug based on the name of the app for use in URLs.

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

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

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

url (URI!)

The URL to the app's homepage.

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

\n AssignedEvent\n

\n

Represents anassignedevent on any assignable object.

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

\n \n \n\n \n

Fields

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

actor (Actor)

Identifies the actor who performed the event.

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

assignable (Assignable!)

Identifies the assignable associated with the event.

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

assignee (Assignee)

Identifies the user or mannequin that was assigned.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

user (User)

Identifies the user who was assigned.

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

Deprecation notice

\n

user is deprecated.

Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

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

\n AutoMergeDisabledEvent\n

\n

Represents aauto_merge_disabledevent on a given pull request.

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

\n \n \n\n \n

Fields

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

actor (Actor)

Identifies the actor who performed the event.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

disabler (User)

The user who disabled auto-merge for this Pull Request.

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

pullRequest (PullRequest)

PullRequest referenced by event.

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

reason (String)

The reason auto-merge was disabled.

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

reasonCode (String)

The reason_code relating to why auto-merge was disabled.

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

\n AutoMergeEnabledEvent\n

\n

Represents aauto_merge_enabledevent on a given pull request.

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

\n \n \n\n \n

Fields

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

actor (Actor)

Identifies the actor who performed the event.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

enabler (User)

The user who enabled auto-merge for this Pull Request.

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

pullRequest (PullRequest)

PullRequest referenced by event.

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

\n AutoMergeRequest\n

\n

Represents an auto-merge request for a pull request.

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

Fields

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

authorEmail (String)

The email address of the author of this auto-merge request.

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

commitBody (String)

The commit message of the auto-merge request.

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

commitHeadline (String)

The commit title of the auto-merge request.

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

enabledAt (DateTime)

When was this auto-merge request was enabled.

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

enabledBy (Actor)

The actor who created the auto-merge request.

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

mergeMethod (PullRequestMergeMethod!)

The merge method of the auto-merge request.

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

pullRequest (PullRequest!)

The pull request that this auto-merge request is set against.

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

\n AutoRebaseEnabledEvent\n

\n

Represents aauto_rebase_enabledevent on a given pull request.

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

\n \n \n\n \n

Fields

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

actor (Actor)

Identifies the actor who performed the event.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

enabler (User)

The user who enabled auto-merge (rebase) for this Pull Request.

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

pullRequest (PullRequest)

PullRequest referenced by event.

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

\n AutoSquashEnabledEvent\n

\n

Represents aauto_squash_enabledevent on a given pull request.

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

\n \n \n\n \n

Fields

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

actor (Actor)

Identifies the actor who performed the event.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

enabler (User)

The user who enabled auto-merge (squash) for this Pull Request.

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

pullRequest (PullRequest)

PullRequest referenced by event.

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

\n AutomaticBaseChangeFailedEvent\n

\n

Represents aautomatic_base_change_failedevent on a given pull request.

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

\n \n \n\n \n

Fields

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

actor (Actor)

Identifies the actor who performed the event.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

newBase (String!)

The new base for this PR.

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

oldBase (String!)

The old base for this PR.

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

pullRequest (PullRequest!)

PullRequest referenced by event.

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

\n AutomaticBaseChangeSucceededEvent\n

\n

Represents aautomatic_base_change_succeededevent on a given pull request.

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

\n \n \n\n \n

Fields

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

actor (Actor)

Identifies the actor who performed the event.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

newBase (String!)

The new base for this PR.

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

oldBase (String!)

The old base for this PR.

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

pullRequest (PullRequest!)

PullRequest referenced by event.

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

\n BaseRefChangedEvent\n

\n

Represents abase_ref_changedevent on a given issue or pull request.

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

\n \n \n\n \n

Fields

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

actor (Actor)

Identifies the actor who performed the event.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

currentRefName (String!)

Identifies the name of the base ref for the pull request after it was changed.

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

databaseId (Int)

Identifies the primary key from the database.

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

previousRefName (String!)

Identifies the name of the base ref for the pull request before it was changed.

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

pullRequest (PullRequest!)

PullRequest referenced by event.

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

\n BaseRefDeletedEvent\n

\n

Represents abase_ref_deletedevent on a given pull request.

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

\n \n \n\n \n

Fields

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

actor (Actor)

Identifies the actor who performed the event.

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

baseRefName (String)

Identifies the name of the Ref associated with the base_ref_deleted event.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

pullRequest (PullRequest)

PullRequest referenced by event.

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

\n BaseRefForcePushedEvent\n

\n

Represents abase_ref_force_pushedevent on a given pull request.

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

\n \n \n\n \n

Fields

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

actor (Actor)

Identifies the actor who performed the event.

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

afterCommit (Commit)

Identifies the after commit SHA for thebase_ref_force_pushedevent.

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

beforeCommit (Commit)

Identifies the before commit SHA for thebase_ref_force_pushedevent.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

pullRequest (PullRequest!)

PullRequest referenced by event.

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

ref (Ref)

Identifies the fully qualified ref name for thebase_ref_force_pushedevent.

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

\n Blame\n

\n

Represents a Git blame.

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

Fields

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

ranges ([BlameRange!]!)

The list of ranges from a Git blame.

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

\n BlameRange\n

\n

Represents a range of information from a Git blame.

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

Fields

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

age (Int!)

Identifies the recency of the change, from 1 (new) to 10 (old). This is\ncalculated as a 2-quantile and determines the length of distance between the\nmedian age of all the changes in the file and the recency of the current\nrange's change.

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

commit (Commit!)

Identifies the line author.

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

endingLine (Int!)

The ending line for the range.

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

startingLine (Int!)

The starting line for the range.

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

\n Blob\n

\n

Represents a Git blob.

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

\n \n \n\n \n

Fields

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

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

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

byteSize (Int!)

Byte size of Blob object.

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

commitResourcePath (URI!)

The HTTP path for this Git object.

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

commitUrl (URI!)

The HTTP URL for this Git object.

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

isBinary (Boolean)

Indicates whether the Blob is binary or text. Returns null if unable to determine the encoding.

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

isTruncated (Boolean!)

Indicates whether the contents is truncated.

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

oid (GitObjectID!)

The Git object ID.

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

repository (Repository!)

The Repository the Git object belongs to.

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

text (String)

UTF8 text data or null if the Blob is binary.

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

\n Bot\n

\n

A special type of user which takes actions on behalf of GitHub Apps.

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

\n \n \n\n \n

Fields

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

avatarUrl (URI!)

A URL pointing to the GitHub App's public avatar.

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

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

databaseId (Int)

Identifies the primary key from the database.

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

login (String!)

The username of the actor.

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

resourcePath (URI!)

The HTTP path for this bot.

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

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

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

url (URI!)

The HTTP URL for this bot.

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

\n BranchProtectionRule\n

\n

A branch protection rule.

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

\n \n \n\n \n

Fields

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

allowsDeletions (Boolean!)

Can this branch be deleted.

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

allowsForcePushes (Boolean!)

Are force pushes allowed on this branch.

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

branchProtectionRuleConflicts (BranchProtectionRuleConflictConnection!)

A list of conflicts matching branches protection rule and other branch protection rules.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

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

creator (Actor)

The actor who created this branch protection rule.

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

databaseId (Int)

Identifies the primary key from the database.

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

dismissesStaleReviews (Boolean!)

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

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

isAdminEnforced (Boolean!)

Can admins overwrite branch protection.

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

matchingRefs (RefConnection!)

Repository refs that are protected by this rule.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters refs with query on name.

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

pattern (String!)

Identifies the protection rule pattern.

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

pushAllowances (PushAllowanceConnection!)

A list push allowances for this branch protection rule.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

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

repository (Repository)

The repository associated with this branch protection rule.

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

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

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

requiredStatusCheckContexts ([String])

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

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

requiresApprovingReviews (Boolean!)

Are approving reviews required to update matching branches.

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

requiresCodeOwnerReviews (Boolean!)

Are reviews from code owners required to update matching branches.

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

requiresCommitSignatures (Boolean!)

Are commits required to be signed.

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

requiresLinearHistory (Boolean!)

Are merge commits prohibited from being pushed to this branch.

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

requiresStatusChecks (Boolean!)

Are status checks required to update matching branches.

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

requiresStrictStatusChecks (Boolean!)

Are branches required to be up to date before merging.

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

restrictsPushes (Boolean!)

Is pushing to matching branches restricted.

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

restrictsReviewDismissals (Boolean!)

Is dismissal of pull request reviews restricted.

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

reviewDismissalAllowances (ReviewDismissalAllowanceConnection!)

A list review dismissal allowances for this branch protection rule.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

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

\n BranchProtectionRuleConflict\n

\n

A conflict between two branch protection rules.

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

Fields

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

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule.

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

conflictingBranchProtectionRule (BranchProtectionRule)

Identifies the conflicting branch protection rule.

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

ref (Ref)

Identifies the branch ref that has conflicting rules.

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

\n BranchProtectionRuleConflictConnection\n

\n

The connection type for BranchProtectionRuleConflict.

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

Fields

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

edges ([BranchProtectionRuleConflictEdge])

A list of edges.

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

nodes ([BranchProtectionRuleConflict])

A list of nodes.

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

pageInfo (PageInfo!)

Information to aid in pagination.

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

totalCount (Int!)

Identifies the total count of items in the connection.

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

\n BranchProtectionRuleConflictEdge\n

\n

An edge in a connection.

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

Fields

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

cursor (String!)

A cursor for use in pagination.

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

node (BranchProtectionRuleConflict)

The item at the end of the edge.

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

\n BranchProtectionRuleConnection\n

\n

The connection type for BranchProtectionRule.

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

Fields

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

edges ([BranchProtectionRuleEdge])

A list of edges.

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

nodes ([BranchProtectionRule])

A list of nodes.

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

pageInfo (PageInfo!)

Information to aid in pagination.

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

totalCount (Int!)

Identifies the total count of items in the connection.

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

\n BranchProtectionRuleEdge\n

\n

An edge in a connection.

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

Fields

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

cursor (String!)

A cursor for use in pagination.

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

node (BranchProtectionRule)

The item at the end of the edge.

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

\n CVSS\n

\n

The Common Vulnerability Scoring System.

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

Fields

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

score (Float!)

The CVSS score associated with this advisory.

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

vectorString (String)

The CVSS vector string associated with this advisory.

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

\n CWE\n

\n

A common weakness enumeration.

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

\n \n \n\n \n

Fields

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

cweId (String!)

The id of the CWE.

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

description (String!)

A detailed description of this CWE.

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

id (ID!)

ID of the object.

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

name (String!)

The name of this CWE.

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

\n CWEConnection\n

\n

The connection type for CWE.

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

Fields

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

edges ([CWEEdge])

A list of edges.

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

nodes ([CWE])

A list of nodes.

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

pageInfo (PageInfo!)

Information to aid in pagination.

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

totalCount (Int!)

Identifies the total count of items in the connection.

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

\n CWEEdge\n

\n

An edge in a connection.

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

Fields

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

cursor (String!)

A cursor for use in pagination.

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

node (CWE)

The item at the end of the edge.

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

\n CheckAnnotation\n

\n

A single check annotation.

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

Fields

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

annotationLevel (CheckAnnotationLevel)

The annotation's severity level.

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

blobUrl (URI!)

The path to the file that this annotation was made on.

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

databaseId (Int)

Identifies the primary key from the database.

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

location (CheckAnnotationSpan!)

The position of this annotation.

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

message (String!)

The annotation's message.

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

path (String!)

The path that this annotation was made on.

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

rawDetails (String)

Additional information about the annotation.

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

title (String)

The annotation's title.

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

\n CheckAnnotationConnection\n

\n

The connection type for CheckAnnotation.

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

Fields

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

edges ([CheckAnnotationEdge])

A list of edges.

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

nodes ([CheckAnnotation])

A list of nodes.

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

pageInfo (PageInfo!)

Information to aid in pagination.

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

totalCount (Int!)

Identifies the total count of items in the connection.

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

\n CheckAnnotationEdge\n

\n

An edge in a connection.

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

Fields

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

cursor (String!)

A cursor for use in pagination.

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

node (CheckAnnotation)

The item at the end of the edge.

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

\n CheckAnnotationPosition\n

\n

A character position in a check annotation.

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

Fields

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

column (Int)

Column number (1 indexed).

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

line (Int!)

Line number (1 indexed).

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

\n CheckAnnotationSpan\n

\n

An inclusive pair of positions for a check annotation.

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

Fields

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

end (CheckAnnotationPosition!)

End position (inclusive).

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

start (CheckAnnotationPosition!)

Start position (inclusive).

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

\n CheckRun\n

\n

A check run.

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

\n \n \n\n \n

Fields

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

annotations (CheckAnnotationConnection)

The check run's annotations.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

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

checkSuite (CheckSuite!)

The check suite that this run is a part of.

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

completedAt (DateTime)

Identifies the date and time when the check run was completed.

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

conclusion (CheckConclusionState)

The conclusion of the check run.

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

databaseId (Int)

Identifies the primary key from the database.

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

detailsUrl (URI)

The URL from which to find full details of the check run on the integrator's site.

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

externalId (String)

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

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

name (String!)

The name of the check for this check run.

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

permalink (URI!)

The permalink to the check run summary.

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

repository (Repository!)

The repository associated with this check run.

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

resourcePath (URI!)

The HTTP path for this check run.

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

startedAt (DateTime)

Identifies the date and time when the check run was started.

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

status (CheckStatusState!)

The current status of the check run.

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

summary (String)

A string representing the check run's summary.

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

text (String)

A string representing the check run's text.

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

title (String)

A string representing the check run.

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

url (URI!)

The HTTP URL for this check run.

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

\n CheckRunConnection\n

\n

The connection type for CheckRun.

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

Fields

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

edges ([CheckRunEdge])

A list of edges.

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

nodes ([CheckRun])

A list of nodes.

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

pageInfo (PageInfo!)

Information to aid in pagination.

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

totalCount (Int!)

Identifies the total count of items in the connection.

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

\n CheckRunEdge\n

\n

An edge in a connection.

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

Fields

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

cursor (String!)

A cursor for use in pagination.

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

node (CheckRun)

The item at the end of the edge.

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

\n CheckSuite\n

\n

A check suite.

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

\n \n \n\n \n

Fields

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

app (App)

The GitHub App which created this check suite.

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

branch (Ref)

The name of the branch for this check suite.

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

checkRuns (CheckRunConnection)

The check runs associated with a check suite.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (CheckRunFilter)

\n

Filters the check runs by this type.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

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

commit (Commit!)

The commit for this check suite.

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

conclusion (CheckConclusionState)

The conclusion of this check suite.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

databaseId (Int)

Identifies the primary key from the database.

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

matchingPullRequests (PullRequestConnection)

A list of open pull requests matching the check suite.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

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

push (Push)

The push that triggered this check suite.

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

repository (Repository!)

The repository associated with this check suite.

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

resourcePath (URI!)

The HTTP path for this check suite.

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

status (CheckStatusState!)

The status of this check suite.

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

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

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

url (URI!)

The HTTP URL for this check suite.

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

\n CheckSuiteConnection\n

\n

The connection type for CheckSuite.

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

Fields

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

edges ([CheckSuiteEdge])

A list of edges.

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

nodes ([CheckSuite])

A list of nodes.

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

pageInfo (PageInfo!)

Information to aid in pagination.

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

totalCount (Int!)

Identifies the total count of items in the connection.

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

\n CheckSuiteEdge\n

\n

An edge in a connection.

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

Fields

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

cursor (String!)

A cursor for use in pagination.

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

node (CheckSuite)

The item at the end of the edge.

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

\n ClosedEvent\n

\n

Represents aclosedevent on any Closable.

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

\n \n \n\n \n

Fields

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

actor (Actor)

Identifies the actor who performed the event.

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

closable (Closable!)

Object that was closed.

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

closer (Closer)

Object which triggered the creation of this event.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

resourcePath (URI!)

The HTTP path for this closed event.

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

url (URI!)

The HTTP URL for this closed event.

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

\n CodeOfConduct\n

\n

The Code of Conduct for a repository.

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

\n \n \n\n \n

Fields

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

body (String)

The body of the Code of Conduct.

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

key (String!)

The key for the Code of Conduct.

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

name (String!)

The formal name of the Code of Conduct.

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

resourcePath (URI)

The HTTP path for this Code of Conduct.

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

url (URI)

The HTTP URL for this Code of Conduct.

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

\n CommentDeletedEvent\n

\n

Represents acomment_deletedevent on a given issue or pull request.

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

\n \n \n\n \n

Fields

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

actor (Actor)

Identifies the actor who performed the event.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

databaseId (Int)

Identifies the primary key from the database.

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

deletedCommentAuthor (Actor)

The user who authored the deleted comment.

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

\n Commit\n

\n

Represents a Git commit.

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

\n \n \n\n \n

Fields

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

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

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

additions (Int!)

The number of additions in this commit.

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

associatedPullRequests (PullRequestConnection)

The pull requests associated with a commit.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (PullRequestOrder)

\n

Ordering options for pull requests.

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

author (GitActor)

Authorship details of the commit.

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

authoredByCommitter (Boolean!)

Check if the committer and the author match.

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

authoredDate (DateTime!)

The datetime when this commit was authored.

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

authors (GitActorConnection!)

The list of authors for this commit based on the git author and the Co-authored-by\nmessage trailer. The git author will always be first.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

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

blame (Blame!)

Fetches git blame information.

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

Arguments

\n\n
\n

path (String!)

\n

The file whose Git blame information you want.

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

changedFiles (Int!)

The number of changed files in this commit.

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

checkSuites (CheckSuiteConnection)

The check suites associated with a commit.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (CheckSuiteFilter)

\n

Filters the check suites by this type.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

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

comments (CommitCommentConnection!)

Comments made on the commit.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

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

commitResourcePath (URI!)

The HTTP path for this Git object.

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

commitUrl (URI!)

The HTTP URL for this Git object.

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

committedDate (DateTime!)

The datetime when this commit was committed.

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

committedViaWeb (Boolean!)

Check if committed via GitHub web UI.

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

committer (GitActor)

Committer details of the commit.

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

deletions (Int!)

The number of deletions in this commit.

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

deployments (DeploymentConnection)

The deployments associated with a commit.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

environments ([String!])

\n

Environments to list deployments for.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (DeploymentOrder)

\n

Ordering options for deployments returned from the connection.

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

file (TreeEntry)

The tree entry representing the file located at the given path.

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

Arguments

\n\n
\n

path (String!)

\n

The path for the file.

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

history (CommitHistoryConnection!)

The linear commit history starting from (and including) this commit, in the same order as git log.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

author (CommitAuthor)

\n

If non-null, filters history to only show commits with matching authorship.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

path (String)

\n

If non-null, filters history to only show commits touching files under this path.

\n\n
\n\n
\n

since (GitTimestamp)

\n

Allows specifying a beginning time or date for fetching commits.

\n\n
\n\n
\n

until (GitTimestamp)

\n

Allows specifying an ending time or date for fetching commits.

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

message (String!)

The Git commit message.

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

messageBody (String!)

The Git commit message body.

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

messageBodyHTML (HTML!)

The commit message body rendered to HTML.

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

messageHeadline (String!)

The Git commit message headline.

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

messageHeadlineHTML (HTML!)

The commit message headline rendered to HTML.

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

oid (GitObjectID!)

The Git object ID.

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

onBehalfOf (Organization)

The organization this commit was made on behalf of.

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

parents (CommitConnection!)

The parents of a commit.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

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

pushedDate (DateTime)

The datetime when this commit was pushed.

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

repository (Repository!)

The Repository this commit belongs to.

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

resourcePath (URI!)

The HTTP path for this commit.

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

signature (GitSignature)

Commit signing information, if present.

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

status (Status)

Status information for this commit.

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

statusCheckRollup (StatusCheckRollup)

Check and Status rollup information for this commit.

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

submodules (SubmoduleConnection!)

Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

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

tarballUrl (URI!)

Returns a URL to download a tarball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

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

tree (Tree!)

Commit's root Tree.

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

treeResourcePath (URI!)

The HTTP path for the tree of this commit.

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

treeUrl (URI!)

The HTTP URL for the tree of this commit.

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

url (URI!)

The HTTP URL for this commit.

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

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

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

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

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

zipballUrl (URI!)

Returns a URL to download a zipball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

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

\n CommitComment\n

\n

Represents a comment on a given Commit.

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

\n \n \n\n \n

Fields

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

author (Actor)

The actor who authored the comment.

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

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

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

body (String!)

Identifies the comment body.

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

bodyHTML (HTML!)

The body rendered to HTML.

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

bodyText (String!)

The body rendered to text.

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

commit (Commit)

Identifies the commit associated with the comment, if the commit exists.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

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

databaseId (Int)

Identifies the primary key from the database.

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

editor (Actor)

The actor who edited the comment.

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

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

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

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

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

lastEditedAt (DateTime)

The moment the editor made the last edit.

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

minimizedReason (String)

Returns why the comment was minimized.

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

path (String)

Identifies the file path associated with the comment.

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

position (Int)

Identifies the line position associated with the comment.

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

publishedAt (DateTime)

Identifies when the comment was published at.

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

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

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

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

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

repository (Repository!)

The repository associated with this node.

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

resourcePath (URI!)

The HTTP path permalink for this commit comment.

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

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

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

url (URI!)

The HTTP URL permalink for this commit comment.

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

userContentEdits (UserContentEditConnection)

A list of edits to this content.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

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

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

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

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

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

viewerCanReact (Boolean!)

Can user react to this subject.

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

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

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

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

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

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

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

\n CommitCommentConnection\n

\n

The connection type for CommitComment.

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

Fields

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

edges ([CommitCommentEdge])

A list of edges.

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

nodes ([CommitComment])

A list of nodes.

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

pageInfo (PageInfo!)

Information to aid in pagination.

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

totalCount (Int!)

Identifies the total count of items in the connection.

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

\n CommitCommentEdge\n

\n

An edge in a connection.

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

Fields

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

cursor (String!)

A cursor for use in pagination.

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

node (CommitComment)

The item at the end of the edge.

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

\n CommitCommentThread\n

\n

A thread of comments on a commit.

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

\n \n \n\n \n

Fields

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

comments (CommitCommentConnection!)

The comments that exist in this thread.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

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

commit (Commit)

The commit the comments were made on.

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

path (String)

The file the comments were made on.

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

position (Int)

The position in the diff for the commit that the comment was made on.

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

repository (Repository!)

The repository associated with this node.

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

\n CommitConnection\n

\n

The connection type for Commit.

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

Fields

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

edges ([CommitEdge])

A list of edges.

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

nodes ([Commit])

A list of nodes.

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

pageInfo (PageInfo!)

Information to aid in pagination.

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

totalCount (Int!)

Identifies the total count of items in the connection.

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

\n CommitContributionsByRepository\n

\n

This aggregates commits made by a user within one repository.

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

Fields

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

contributions (CreatedCommitContributionConnection!)

The commit contributions, each representing a day.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (CommitContributionOrder)

\n

Ordering options for commit contributions returned from the connection.

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

repository (Repository!)

The repository in which the commits were made.

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

resourcePath (URI!)

The HTTP path for the user's commits to the repository in this time range.

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

url (URI!)

The HTTP URL for the user's commits to the repository in this time range.

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

\n CommitEdge\n

\n

An edge in a connection.

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

Fields

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

cursor (String!)

A cursor for use in pagination.

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

node (Commit)

The item at the end of the edge.

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

\n CommitHistoryConnection\n

\n

The connection type for Commit.

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

Fields

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

edges ([CommitEdge])

A list of edges.

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

nodes ([Commit])

A list of nodes.

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

pageInfo (PageInfo!)

Information to aid in pagination.

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

totalCount (Int!)

Identifies the total count of items in the connection.

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

\n ConnectedEvent\n

\n

Represents aconnectedevent on a given issue or pull request.

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

\n \n \n\n \n

Fields

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

actor (Actor)

Identifies the actor who performed the event.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

isCrossRepository (Boolean!)

Reference originated in a different repository.

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

source (ReferencedSubject!)

Issue or pull request that made the reference.

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

subject (ReferencedSubject!)

Issue or pull request which was connected.

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

\n ContentAttachment\n

\n

A content attachment.

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

Fields

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

body (String!)

The body text of the content attachment. This parameter supports markdown.

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

contentReference (ContentReference!)

The content reference that the content attachment is attached to.

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

databaseId (Int!)

Identifies the primary key from the database.

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

title (String!)

The title of the content attachment.

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

\n ContentReference\n

\n

A content reference.

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

Fields

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

databaseId (Int!)

Identifies the primary key from the database.

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

reference (String!)

The reference of the content reference.

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

\n ContributionCalendar\n

\n

A calendar of contributions made on GitHub by a user.

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

Fields

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

colors ([String!]!)

A list of hex color codes used in this calendar. The darker the color, the more contributions it represents.

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

isHalloween (Boolean!)

Determine if the color set was chosen because it's currently Halloween.

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

months ([ContributionCalendarMonth!]!)

A list of the months of contributions in this calendar.

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

totalContributions (Int!)

The count of total contributions in the calendar.

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

weeks ([ContributionCalendarWeek!]!)

A list of the weeks of contributions in this calendar.

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

\n ContributionCalendarDay\n

\n

Represents a single day of contributions on GitHub by a user.

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

Fields

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

color (String!)

The hex color code that represents how many contributions were made on this day compared to others in the calendar.

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

contributionCount (Int!)

How many contributions were made by the user on this day.

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

contributionLevel (ContributionLevel!)

Indication of contributions, relative to other days. Can be used to indicate\nwhich color to represent this day on a calendar.

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

date (Date!)

The day this square represents.

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

weekday (Int!)

A number representing which day of the week this square represents, e.g., 1 is Monday.

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

\n ContributionCalendarMonth\n

\n

A month of contributions in a user's contribution graph.

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

Fields

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

firstDay (Date!)

The date of the first day of this month.

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

name (String!)

The name of the month.

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

totalWeeks (Int!)

How many weeks started in this month.

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

year (Int!)

The year the month occurred in.

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

\n ContributionCalendarWeek\n

\n

A week of contributions in a user's contribution graph.

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

Fields

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

contributionDays ([ContributionCalendarDay!]!)

The days of contributions in this week.

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

firstDay (Date!)

The date of the earliest square in this week.

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

\n ContributionsCollection\n

\n

A contributions collection aggregates contributions such as opened issues and commits created by a user.

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

Fields

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

commitContributionsByRepository ([CommitContributionsByRepository!]!)

Commit contributions made by the user, grouped by repository.

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

Arguments

\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

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

contributionCalendar (ContributionCalendar!)

A calendar of this user's contributions on GitHub.

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

contributionYears ([Int!]!)

The years the user has been making contributions with the most recent year first.

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

doesEndInCurrentMonth (Boolean!)

Determine if this collection's time span ends in the current month.

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

earliestRestrictedContributionDate (Date)

The date of the first restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

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

endedAt (DateTime!)

The ending date and time of this collection.

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

firstIssueContribution (CreatedIssueOrRestrictedContribution)

The first issue the user opened on GitHub. This will be null if that issue was\nopened outside the collection's time range and ignoreTimeRange is false. If\nthe issue is not visible but the user has opted to show private contributions,\na RestrictedContribution will be returned.

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

firstPullRequestContribution (CreatedPullRequestOrRestrictedContribution)

The first pull request the user opened on GitHub. This will be null if that\npull request was opened outside the collection's time range and\nignoreTimeRange is not true. If the pull request is not visible but the user\nhas opted to show private contributions, a RestrictedContribution will be returned.

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

firstRepositoryContribution (CreatedRepositoryOrRestrictedContribution)

The first repository the user created on GitHub. This will be null if that\nfirst repository was created outside the collection's time range and\nignoreTimeRange is false. If the repository is not visible, then a\nRestrictedContribution is returned.

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

hasActivityInThePast (Boolean!)

Does the user have any more activity in the timeline that occurred prior to the collection's time range?.

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

hasAnyContributions (Boolean!)

Determine if there are any contributions in this collection.

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

hasAnyRestrictedContributions (Boolean!)

Determine if the user made any contributions in this time frame whose details\nare not visible because they were made in a private repository. Can only be\ntrue if the user enabled private contribution counts.

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

isSingleDay (Boolean!)

Whether or not the collector's time span is all within the same day.

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

issueContributions (CreatedIssueContributionConnection!)

A list of issues the user opened.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

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

issueContributionsByRepository ([IssueContributionsByRepository!]!)

Issue contributions made by the user, grouped by repository.

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

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

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

joinedGitHubContribution (JoinedGitHubContribution)

When the user signed up for GitHub. This will be null if that sign up date\nfalls outside the collection's time range and ignoreTimeRange is false.

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

latestRestrictedContributionDate (Date)

The date of the most recent restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

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

mostRecentCollectionWithActivity (ContributionsCollection)

When this collection's time range does not include any activity from the user, use this\nto get a different collection from an earlier time range that does have activity.

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

mostRecentCollectionWithoutActivity (ContributionsCollection)

Returns a different contributions collection from an earlier time range than this one\nthat does not have any contributions.

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

popularIssueContribution (CreatedIssueContribution)

The issue the user opened on GitHub that received the most comments in the specified\ntime frame.

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

popularPullRequestContribution (CreatedPullRequestContribution)

The pull request the user opened on GitHub that received the most comments in the\nspecified time frame.

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

pullRequestContributions (CreatedPullRequestContributionConnection!)

Pull request contributions made by the user.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

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

pullRequestContributionsByRepository ([PullRequestContributionsByRepository!]!)

Pull request contributions made by the user, grouped by repository.

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

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

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

pullRequestReviewContributions (CreatedPullRequestReviewContributionConnection!)

Pull request review contributions made by the user.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

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

pullRequestReviewContributionsByRepository ([PullRequestReviewContributionsByRepository!]!)

Pull request review contributions made by the user, grouped by repository.

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

Arguments

\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

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

repositoryContributions (CreatedRepositoryContributionConnection!)

A list of repositories owned by the user that the user created in this time range.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first repository ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

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

restrictedContributionsCount (Int!)

A count of contributions made by the user that the viewer cannot access. Only\nnon-zero when the user has chosen to share their private contribution counts.

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

startedAt (DateTime!)

The beginning date and time of this collection.

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

totalCommitContributions (Int!)

How many commits were made by the user in this time span.

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

totalIssueContributions (Int!)

How many issues the user opened.

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

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from this count.

\n

The default value is false.

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

totalPullRequestContributions (Int!)

How many pull requests the user opened.

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

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from this count.

\n

The default value is false.

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

totalPullRequestReviewContributions (Int!)

How many pull request reviews the user left.

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

totalRepositoriesWithContributedCommits (Int!)

How many different repositories the user committed to.

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

totalRepositoriesWithContributedIssues (Int!)

How many different repositories the user opened issues in.

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

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from this count.

\n

The default value is false.

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

totalRepositoriesWithContributedPullRequestReviews (Int!)

How many different repositories the user left pull request reviews in.

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

totalRepositoriesWithContributedPullRequests (Int!)

How many different repositories the user opened pull requests in.

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

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from this count.

\n

The default value is false.

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

totalRepositoryContributions (Int!)

How many repositories the user created.

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

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first repository ever be excluded from this count.

\n

The default value is false.

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

user (User!)

The user who made the contributions in this collection.

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

\n ConvertToDraftEvent\n

\n

Represents aconvert_to_draftevent on a given pull request.

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

\n \n \n\n \n

Fields

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

actor (Actor)

Identifies the actor who performed the event.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

pullRequest (PullRequest!)

PullRequest referenced by event.

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

resourcePath (URI!)

The HTTP path for this convert to draft event.

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

url (URI!)

The HTTP URL for this convert to draft event.

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

\n ConvertedNoteToIssueEvent\n

\n

Represents aconverted_note_to_issueevent on a given issue or pull request.

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

\n \n \n\n \n

Fields

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

actor (Actor)

Identifies the actor who performed the event.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

databaseId (Int)

Identifies the primary key from the database.

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

project (Project)

Project referenced by event.

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

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

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

projectCard (ProjectCard)

Project card referenced by this project event.

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

Preview notice

\n

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

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

projectColumnName (String!)

Column name referenced by this project event.

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

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

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

\n CreatedCommitContribution\n

\n

Represents the contribution a user made by committing to a repository.

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

\n \n \n\n \n

Fields

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

commitCount (Int!)

How many commits were made on this day to this repository by the user.

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

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

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

occurredAt (DateTime!)

When this contribution was made.

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

repository (Repository!)

The repository the user made a commit in.

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

resourcePath (URI!)

The HTTP path for this contribution.

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

url (URI!)

The HTTP URL for this contribution.

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

user (User!)

The user who made this contribution.

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

\n CreatedCommitContributionConnection\n

\n

The connection type for CreatedCommitContribution.

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

Fields

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

edges ([CreatedCommitContributionEdge])

A list of edges.

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

nodes ([CreatedCommitContribution])

A list of nodes.

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

pageInfo (PageInfo!)

Information to aid in pagination.

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

totalCount (Int!)

Identifies the total count of commits across days and repositories in the connection.

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

\n CreatedCommitContributionEdge\n

\n

An edge in a connection.

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

Fields

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

cursor (String!)

A cursor for use in pagination.

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

node (CreatedCommitContribution)

The item at the end of the edge.

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

\n CreatedIssueContribution\n

\n

Represents the contribution a user made on GitHub by opening an issue.

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

\n \n \n\n \n

Fields

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

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

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

issue (Issue!)

The issue that was opened.

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

occurredAt (DateTime!)

When this contribution was made.

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

resourcePath (URI!)

The HTTP path for this contribution.

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

url (URI!)

The HTTP URL for this contribution.

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

user (User!)

The user who made this contribution.

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

\n CreatedIssueContributionConnection\n

\n

The connection type for CreatedIssueContribution.

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

Fields

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

edges ([CreatedIssueContributionEdge])

A list of edges.

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

nodes ([CreatedIssueContribution])

A list of nodes.

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

pageInfo (PageInfo!)

Information to aid in pagination.

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

totalCount (Int!)

Identifies the total count of items in the connection.

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

\n CreatedIssueContributionEdge\n

\n

An edge in a connection.

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

Fields

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

cursor (String!)

A cursor for use in pagination.

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

node (CreatedIssueContribution)

The item at the end of the edge.

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

\n CreatedPullRequestContribution\n

\n

Represents the contribution a user made on GitHub by opening a pull request.

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

\n \n \n\n \n

Fields

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

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

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

occurredAt (DateTime!)

When this contribution was made.

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

pullRequest (PullRequest!)

The pull request that was opened.

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

resourcePath (URI!)

The HTTP path for this contribution.

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

url (URI!)

The HTTP URL for this contribution.

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

user (User!)

The user who made this contribution.

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

\n CreatedPullRequestContributionConnection\n

\n

The connection type for CreatedPullRequestContribution.

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

Fields

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

edges ([CreatedPullRequestContributionEdge])

A list of edges.

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

nodes ([CreatedPullRequestContribution])

A list of nodes.

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

pageInfo (PageInfo!)

Information to aid in pagination.

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

totalCount (Int!)

Identifies the total count of items in the connection.

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

\n CreatedPullRequestContributionEdge\n

\n

An edge in a connection.

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

Fields

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

cursor (String!)

A cursor for use in pagination.

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

node (CreatedPullRequestContribution)

The item at the end of the edge.

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

\n CreatedPullRequestReviewContribution\n

\n

Represents the contribution a user made by leaving a review on a pull request.

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

\n \n \n\n \n

Fields

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

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

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

occurredAt (DateTime!)

When this contribution was made.

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

pullRequest (PullRequest!)

The pull request the user reviewed.

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

pullRequestReview (PullRequestReview!)

The review the user left on the pull request.

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

repository (Repository!)

The repository containing the pull request that the user reviewed.

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

resourcePath (URI!)

The HTTP path for this contribution.

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

url (URI!)

The HTTP URL for this contribution.

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

user (User!)

The user who made this contribution.

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

\n CreatedPullRequestReviewContributionConnection\n

\n

The connection type for CreatedPullRequestReviewContribution.

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

Fields

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

edges ([CreatedPullRequestReviewContributionEdge])

A list of edges.

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

nodes ([CreatedPullRequestReviewContribution])

A list of nodes.

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

pageInfo (PageInfo!)

Information to aid in pagination.

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

totalCount (Int!)

Identifies the total count of items in the connection.

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

\n CreatedPullRequestReviewContributionEdge\n

\n

An edge in a connection.

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

Fields

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

cursor (String!)

A cursor for use in pagination.

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

node (CreatedPullRequestReviewContribution)

The item at the end of the edge.

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

\n CreatedRepositoryContribution\n

\n

Represents the contribution a user made on GitHub by creating a repository.

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

\n \n \n\n \n

Fields

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

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

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

occurredAt (DateTime!)

When this contribution was made.

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

repository (Repository!)

The repository that was created.

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

resourcePath (URI!)

The HTTP path for this contribution.

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

url (URI!)

The HTTP URL for this contribution.

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

user (User!)

The user who made this contribution.

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

\n CreatedRepositoryContributionConnection\n

\n

The connection type for CreatedRepositoryContribution.

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

Fields

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

edges ([CreatedRepositoryContributionEdge])

A list of edges.

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

nodes ([CreatedRepositoryContribution])

A list of nodes.

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

pageInfo (PageInfo!)

Information to aid in pagination.

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

totalCount (Int!)

Identifies the total count of items in the connection.

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

\n CreatedRepositoryContributionEdge\n

\n

An edge in a connection.

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

Fields

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

cursor (String!)

A cursor for use in pagination.

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

node (CreatedRepositoryContribution)

The item at the end of the edge.

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

\n CrossReferencedEvent\n

\n

Represents a mention made by one issue or pull request to another.

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

\n \n \n\n \n

Fields

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

actor (Actor)

Identifies the actor who performed the event.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

isCrossRepository (Boolean!)

Reference originated in a different repository.

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

referencedAt (DateTime!)

Identifies when the reference was made.

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

resourcePath (URI!)

The HTTP path for this pull request.

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

source (ReferencedSubject!)

Issue or pull request that made the reference.

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

target (ReferencedSubject!)

Issue or pull request to which the reference was made.

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

url (URI!)

The HTTP URL for this pull request.

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

willCloseTarget (Boolean!)

Checks if the target will be closed when the source is merged.

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

\n DemilestonedEvent\n

\n

Represents ademilestonedevent on a given issue or pull request.

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

\n \n \n\n \n

Fields

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

actor (Actor)

Identifies the actor who performed the event.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

milestoneTitle (String!)

Identifies the milestone title associated with thedemilestonedevent.

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

subject (MilestoneItem!)

Object referenced by event.

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

\n DependencyGraphDependency\n

\n

A dependency manifest entry.

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

Preview notice

\n

DependencyGraphDependency is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

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

Fields

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

hasDependencies (Boolean!)

Does the dependency itself have dependencies?.

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

packageManager (String)

The dependency package manager.

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

packageName (String!)

The required package name.

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

repository (Repository)

The repository containing the package.

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

requirements (String!)

The dependency version requirements.

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

\n DependencyGraphDependencyConnection\n

\n

The connection type for DependencyGraphDependency.

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

Preview notice

\n

DependencyGraphDependencyConnection is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

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

Fields

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

edges ([DependencyGraphDependencyEdge])

A list of edges.

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

nodes ([DependencyGraphDependency])

A list of nodes.

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

pageInfo (PageInfo!)

Information to aid in pagination.

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

totalCount (Int!)

Identifies the total count of items in the connection.

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

\n DependencyGraphDependencyEdge\n

\n

An edge in a connection.

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

Preview notice

\n

DependencyGraphDependencyEdge is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

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

Fields

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

cursor (String!)

A cursor for use in pagination.

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

node (DependencyGraphDependency)

The item at the end of the edge.

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

\n DependencyGraphManifest\n

\n

Dependency manifest for a repository.

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

Preview notice

\n

DependencyGraphManifest is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

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

\n \n \n\n \n

Fields

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

blobPath (String!)

Path to view the manifest file blob.

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

dependencies (DependencyGraphDependencyConnection)

A list of manifest dependencies.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

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

dependenciesCount (Int)

The number of dependencies listed in the manifest.

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

exceedsMaxSize (Boolean!)

Is the manifest too big to parse?.

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

filename (String!)

Fully qualified manifest filename.

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

parseable (Boolean!)

Were we able to parse the manifest?.

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

repository (Repository!)

The repository containing the manifest.

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

\n DependencyGraphManifestConnection\n

\n

The connection type for DependencyGraphManifest.

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

Preview notice

\n

DependencyGraphManifestConnection is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

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

Fields

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

edges ([DependencyGraphManifestEdge])

A list of edges.

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

nodes ([DependencyGraphManifest])

A list of nodes.

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

pageInfo (PageInfo!)

Information to aid in pagination.

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

totalCount (Int!)

Identifies the total count of items in the connection.

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

\n DependencyGraphManifestEdge\n

\n

An edge in a connection.

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

Preview notice

\n

DependencyGraphManifestEdge is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

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

Fields

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

cursor (String!)

A cursor for use in pagination.

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

node (DependencyGraphManifest)

The item at the end of the edge.

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

\n DeployKey\n

\n

A repository deploy key.

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

\n \n \n\n \n

Fields

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

key (String!)

The deploy key.

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

readOnly (Boolean!)

Whether or not the deploy key is read only.

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

title (String!)

The deploy key title.

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

verified (Boolean!)

Whether or not the deploy key has been verified.

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

\n DeployKeyConnection\n

\n

The connection type for DeployKey.

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

Fields

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

edges ([DeployKeyEdge])

A list of edges.

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

nodes ([DeployKey])

A list of nodes.

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

pageInfo (PageInfo!)

Information to aid in pagination.

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

totalCount (Int!)

Identifies the total count of items in the connection.

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

\n DeployKeyEdge\n

\n

An edge in a connection.

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

Fields

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

cursor (String!)

A cursor for use in pagination.

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

node (DeployKey)

The item at the end of the edge.

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

\n DeployedEvent\n

\n

Represents adeployedevent on a given pull request.

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

\n \n \n\n \n

Fields

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

actor (Actor)

Identifies the actor who performed the event.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

databaseId (Int)

Identifies the primary key from the database.

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

deployment (Deployment!)

The deployment associated with thedeployedevent.

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

pullRequest (PullRequest!)

PullRequest referenced by event.

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

ref (Ref)

The ref associated with thedeployedevent.

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

\n Deployment\n

\n

Represents triggered deployment instance.

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

\n \n \n\n \n

Fields

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

commit (Commit)

Identifies the commit sha of the deployment.

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

commitOid (String!)

Identifies the oid of the deployment commit, even if the commit has been deleted.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

creator (Actor!)

Identifies the actor who triggered the deployment.

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

databaseId (Int)

Identifies the primary key from the database.

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

description (String)

The deployment description.

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

environment (String)

The latest environment to which this deployment was made.

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

latestEnvironment (String)

The latest environment to which this deployment was made.

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

latestStatus (DeploymentStatus)

The latest status of this deployment.

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

originalEnvironment (String)

The original environment to which this deployment was made.

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

payload (String)

Extra information that a deployment system might need.

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

ref (Ref)

Identifies the Ref of the deployment, if the deployment was created by ref.

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

repository (Repository!)

Identifies the repository associated with the deployment.

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

state (DeploymentState)

The current state of the deployment.

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

statuses (DeploymentStatusConnection)

A list of statuses associated with the deployment.

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

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

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

task (String)

The deployment task.

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

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

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

\n DeploymentConnection\n

\n

The connection type for Deployment.

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

Fields

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

edges ([DeploymentEdge])

A list of edges.

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

nodes ([Deployment])

A list of nodes.

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

pageInfo (PageInfo!)

Information to aid in pagination.

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

totalCount (Int!)

Identifies the total count of items in the connection.

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

\n DeploymentEdge\n

\n

An edge in a connection.

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

Fields

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

cursor (String!)

A cursor for use in pagination.

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

node (Deployment)

The item at the end of the edge.

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

\n DeploymentEnvironmentChangedEvent\n

\n

Represents adeployment_environment_changedevent on a given pull request.

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

\n \n \n\n \n

Fields

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

actor (Actor)

Identifies the actor who performed the event.

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

deploymentStatus (DeploymentStatus!)

The deployment status that updated the deployment environment.

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

pullRequest (PullRequest!)

PullRequest referenced by event.

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

\n DeploymentStatus\n

\n

Describes the status of a given deployment attempt.

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

\n \n \n\n \n

Fields

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

createdAt (DateTime!)

Identifies the date and time when the object was created.

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

creator (Actor!)

Identifies the actor who triggered the deployment.

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

deployment (Deployment!)

Identifies the deployment associated with status.

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

description (String)

Identifies the description of the deployment.

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

environment (String)

Identifies the environment of the deployment at the time of this deployment status.

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

Preview notice

\n

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

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

environmentUrl (URI)

Identifies the environment URL of the deployment.

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

logUrl (URI)

Identifies the log URL of the deployment.

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

state (DeploymentStatusState!)

Identifies the current state of the deployment.

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

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

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

\n DeploymentStatusConnection\n

\n

The connection type for DeploymentStatus.

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

Fields

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

edges ([DeploymentStatusEdge])

A list of edges.

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

nodes ([DeploymentStatus])

A list of nodes.

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

pageInfo (PageInfo!)

Information to aid in pagination.

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

totalCount (Int!)

Identifies the total count of items in the connection.

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

\n DeploymentStatusEdge\n

\n

An edge in a connection.

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

Fields

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

cursor (String!)

A cursor for use in pagination.

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

node (DeploymentStatus)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DisconnectedEvent\n

\n

Represents adisconnectedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

source (ReferencedSubject!)

Issue or pull request from which the issue was disconnected.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (ReferencedSubject!)

Issue or pull request which was disconnected.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Enterprise\n

\n

An account to manage multiple organizations with consolidated policy and billing.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the enterprise's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

billingInfo (EnterpriseBillingInfo)

Enterprise billing information visible to enterprise billing managers.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML!)

The description of the enterprise as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The location of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

members (EnterpriseMemberConnection!)

A list of users who are members of this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

deployment (EnterpriseUserDeployment)

\n

Only return members within the selected GitHub Enterprise deployment.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for members returned from the connection.

\n\n
\n\n
\n

organizationLogins ([String!])

\n

Only return members within the organizations with these logins.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseUserAccountMembershipRole)

\n

The role of the user in the enterprise organization or server.

\n\n
\n\n
\n\n\n

name (String!)

The name of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

organizations (OrganizationConnection!)

A list of organizations that belong to this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

ownerInfo (EnterpriseOwnerInfo)

Enterprise information only visible to enterprise owners.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

slug (String!)

The URL-friendly identifier for the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

userAccounts (EnterpriseUserAccountConnection!)

A list of user accounts on this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerIsAdmin (Boolean!)

Is the current viewer an admin of this enterprise?.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (URI)

The URL of the enterprise website.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseAdministratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorEdge\n

\n

A User who is an administrator of an enterprise.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole!)

The role of the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitation\n

\n

An invitation for a user to become an owner or billing manager of an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email of the person who was invited to the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise!)

The enterprise the invitation is for.

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (User)

The user who was invited to the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

inviter (User)

The user who created the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole!)

The invitee's pending role in the enterprise (owner or billing_manager).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationConnection\n

\n

The connection type for EnterpriseAdministratorInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseAdministratorInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseAdministratorInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseAdministratorInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseBillingInfo\n

\n

Enterprise billing information visible to enterprise billing managers and owners.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allLicensableUsersCount (Int!)

The number of licenseable users/emails across the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

assetPacks (Int!)

The number of data packs used by all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

availableSeats (Int!)

The number of available seats across all owned organizations based on the unique number of billable users.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

availableSeats is deprecated.

availableSeats will be replaced with totalAvailableLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalAvailableLicenses instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n

bandwidthQuota (Float!)

The bandwidth quota in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

bandwidthUsage (Float!)

The bandwidth usage in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

bandwidthUsagePercentage (Int!)

The bandwidth usage as a percentage of the bandwidth quota.

\n\n\n\n\n\n\n\n\n\n\n\n

seats (Int!)

The total seats across all organizations owned by the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

seats is deprecated.

seats will be replaced with totalLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalLicenses instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n

storageQuota (Float!)

The storage quota in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

storageUsage (Float!)

The storage usage in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

storageUsagePercentage (Int!)

The storage usage as a percentage of the storage quota.

\n\n\n\n\n\n\n\n\n\n\n\n

totalAvailableLicenses (Int!)

The number of available licenses across all owned organizations based on the unique number of billable users.

\n\n\n\n\n\n\n\n\n\n\n\n

totalLicenses (Int!)

The total number of licenses allocated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseIdentityProvider\n

\n

An identity provider configured to provision identities for an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

digestMethod (SamlDigestAlgorithm)

The digest algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise)

The enterprise this identity provider belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

externalIdentities (ExternalIdentityConnection!)

ExternalIdentities provisioned by this identity provider.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

idpCertificate (X509Certificate)

The x509 certificate used by the identity provider to sign assertions and responses.

\n\n\n\n\n\n\n\n\n\n\n\n

issuer (String)

The Issuer Entity ID for the SAML identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

recoveryCodes ([String!])

Recovery codes that can be used by admins to access the enterprise if the identity provider is unavailable.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethod (SamlSignatureAlgorithm)

The signature algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

ssoUrl (URI)

The URL endpoint for the identity provider's SAML SSO.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberConnection\n

\n

The connection type for EnterpriseMember.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseMemberEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseMember])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberEdge\n

\n

A User who is a member of an enterprise through one or more organizations.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the user does not have a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All members consume a license Removal on 2021-01-01 UTC.

\n
\n\n\n\n\n\n\n

node (EnterpriseMember)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOrganizationMembershipConnection\n

\n

The connection type for Organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseOrganizationMembershipEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Organization])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOrganizationMembershipEdge\n

\n

An enterprise organization that a user is a member of.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Organization)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseUserAccountMembershipRole!)

The role of the user in the enterprise membership.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOutsideCollaboratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseOutsideCollaboratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOutsideCollaboratorEdge\n

\n

A User who is an outside collaborator of an enterprise through one or more organizations.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the outside collaborator does not have a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All outside collaborators consume a license Removal on 2021-01-01 UTC.

\n
\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (EnterpriseRepositoryInfoConnection!)

The enterprise organization repositories this user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOwnerInfo\n

\n

Enterprise information only visible to enterprise owners.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

admins (EnterpriseAdministratorConnection!)

A list of all of the administrators for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for administrators returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseAdministratorRole)

\n

The role to filter by.

\n\n
\n\n
\n\n\n

affiliatedUsersWithTwoFactorDisabled (UserConnection!)

A list of users in the enterprise who currently have two-factor authentication disabled.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

affiliatedUsersWithTwoFactorDisabledExist (Boolean!)

Whether or not affiliated users with two-factor authentication disabled exist in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

allowPrivateRepositoryForkingSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether private repository forking is enabled for repositories in organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

allowPrivateRepositoryForkingSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided private repository forking setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

defaultRepositoryPermissionSetting (EnterpriseDefaultRepositoryPermissionSettingValue!)

The setting value for base repository permissions for organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

defaultRepositoryPermissionSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided default repository permission.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (DefaultRepositoryPermissionField!)

\n

The permission to find organizations for.

\n\n
\n\n
\n\n\n

domains (VerifiableDomainConnection!)

A list of domains owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isVerified (Boolean)

\n

Filter whether or not the domain is verified.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (VerifiableDomainOrder)

\n

Ordering options for verifiable domains returned.

\n\n
\n\n
\n\n\n

enterpriseServerInstallations (EnterpriseServerInstallationConnection!)

Enterprise Server installations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

connectedOnly (Boolean)

\n

Whether or not to only return installations discovered via GitHub Connect.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerInstallationOrder)

\n

Ordering options for Enterprise Server installations returned.

\n\n
\n\n
\n\n\n

ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

The setting value for whether the enterprise has an IP allow list enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntries (IpAllowListEntryConnection!)

The IP addresses that are allowed to access resources owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IpAllowListEntryOrder)

\n

Ordering options for IP allow list entries returned.

\n\n
\n\n
\n\n\n

isUpdatingDefaultRepositoryPermission (Boolean!)

Whether or not the default repository permission is currently being updated.

\n\n\n\n\n\n\n\n\n\n\n\n

isUpdatingTwoFactorRequirement (Boolean!)

Whether the two-factor authentication requirement is currently being enforced.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanChangeRepositoryVisibilitySetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether organization members with admin permissions on a\nrepository can change repository visibility.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanChangeRepositoryVisibilitySettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided can change repository visibility setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanCreateInternalRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create internal repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePrivateRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create private repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePublicRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create public repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesSetting (EnterpriseMembersCanCreateRepositoriesSettingValue)

The setting value for whether members of organizations in the enterprise can create repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided repository creation setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (OrganizationMembersCanCreateRepositoriesSettingValue!)

\n

The setting to find organizations for.

\n\n
\n\n
\n\n\n

membersCanDeleteIssuesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can delete issues.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanDeleteIssuesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can delete issues setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanDeleteRepositoriesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can delete or transfer repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanDeleteRepositoriesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can delete repositories setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanInviteCollaboratorsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members of organizations in the enterprise can invite outside collaborators.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanInviteCollaboratorsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can invite collaborators setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanMakePurchasesSetting (EnterpriseMembersCanMakePurchasesSettingValue!)

Indicates whether members of this enterprise's organizations can purchase additional services for those organizations.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanUpdateProtectedBranchesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can update protected branches.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanUpdateProtectedBranchesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can update protected branches setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanViewDependencyInsightsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members can view dependency insights.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanViewDependencyInsightsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can view dependency insights setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

notificationDeliveryRestrictionEnabledSetting (NotificationRestrictionSettingValue!)

Indicates if email notification delivery for this enterprise is restricted to verified domains.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether organization projects are enabled for organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationProjectsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided organization projects setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

outsideCollaborators (EnterpriseOutsideCollaboratorConnection!)

A list of outside collaborators across the repositories in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

login (String)

\n

The login of one specific outside collaborator.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for outside collaborators returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

visibility (RepositoryVisibility)

\n

Only return outside collaborators on repositories with this visibility.

\n\n
\n\n
\n\n\n

pendingAdminInvitations (EnterpriseAdministratorInvitationConnection!)

A list of pending administrator invitations for the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseAdministratorInvitationOrder)

\n

Ordering options for pending enterprise administrator invitations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseAdministratorRole)

\n

The role to filter by.

\n\n
\n\n
\n\n\n

pendingCollaboratorInvitations (RepositoryInvitationConnection!)

A list of pending collaborator invitations across the repositories in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryInvitationOrder)

\n

Ordering options for pending repository collaborator invitations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

pendingCollaborators (EnterprisePendingCollaboratorConnection!)

A list of pending collaborators across the repositories in the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

pendingCollaborators is deprecated.

Repository invitations can now be associated with an email, not only an invitee. Use the pendingCollaboratorInvitations field instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryInvitationOrder)

\n

Ordering options for pending repository collaborator invitations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

pendingMemberInvitations (EnterprisePendingMemberInvitationConnection!)

A list of pending member invitations for organizations in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

repositoryProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether repository projects are enabled in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryProjectsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided repository projects setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

samlIdentityProvider (EnterpriseIdentityProvider)

The SAML Identity Provider for the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

samlIdentityProviderSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the SAML single sign-on setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (IdentityProviderConfigurationState!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

supportEntitlements (EnterpriseMemberConnection!)

A list of members with a support entitlement.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for support entitlement users returned from the connection.

\n\n
\n\n
\n\n\n

teamDiscussionsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether team discussions are enabled for organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

teamDiscussionsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided team discussions setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

twoFactorRequiredSetting (EnterpriseEnabledSettingValue!)

The setting value for whether the enterprise requires two-factor authentication for its organizations and users.

\n\n\n\n\n\n\n\n\n\n\n\n

twoFactorRequiredSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the two-factor authentication setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingCollaboratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterprisePendingCollaboratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingCollaboratorEdge\n

\n

A user with an invitation to be a collaborator on a repository owned by an organization in an enterprise.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the invited collaborator does not have a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All pending collaborators consume a license Removal on 2021-01-01 UTC.

\n
\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (EnterpriseRepositoryInfoConnection!)

The enterprise organization repositories this user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingMemberInvitationConnection\n

\n

The connection type for OrganizationInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterprisePendingMemberInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([OrganizationInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalUniqueUserCount (Int!)

Identifies the total count of unique users in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingMemberInvitationEdge\n

\n

An invitation to be a member in an enterprise organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the invitation has a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All pending members consume a license Removal on 2020-07-01 UTC.

\n
\n\n\n\n\n\n\n

node (OrganizationInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseRepositoryInfo\n

\n

A subset of repository information queryable from an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isPrivate (Boolean!)

Identifies if the repository is private.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The repository's name.

\n\n\n\n\n\n\n\n\n\n\n\n

nameWithOwner (String!)

The repository's name with owner.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseRepositoryInfoConnection\n

\n

The connection type for EnterpriseRepositoryInfo.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseRepositoryInfoEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseRepositoryInfo])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseRepositoryInfoEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseRepositoryInfo)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerInstallation\n

\n

An Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

customerName (String!)

The customer name to which the Enterprise Server installation belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

hostName (String!)

The host name of the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

isConnected (Boolean!)

Whether or not the installation is connected to an Enterprise Server installation via GitHub Connect.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

userAccounts (EnterpriseServerUserAccountConnection!)

User accounts on this Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerUserAccountOrder)

\n

Ordering options for Enterprise Server user accounts returned from the connection.

\n\n
\n\n
\n\n\n

userAccountsUploads (EnterpriseServerUserAccountsUploadConnection!)

User accounts uploads for the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerUserAccountsUploadOrder)

\n

Ordering options for Enterprise Server user accounts uploads returned from the connection.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerInstallationConnection\n

\n

The connection type for EnterpriseServerInstallation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerInstallationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerInstallation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerInstallationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerInstallation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccount\n

\n

A user account on an Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

emails (EnterpriseServerUserAccountEmailConnection!)

User emails belonging to this user account.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerUserAccountEmailOrder)

\n

Ordering options for Enterprise Server user account emails returned from the connection.

\n\n
\n\n
\n\n\n

enterpriseServerInstallation (EnterpriseServerInstallation!)

The Enterprise Server installation on which this user account exists.

\n\n\n\n\n\n\n\n\n\n\n\n

isSiteAdmin (Boolean!)

Whether the user account is a site administrator on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user account on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

profileName (String)

The profile name of the user account on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

remoteCreatedAt (DateTime!)

The date and time when the user account was created on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

remoteUserId (Int!)

The ID of the user account on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountConnection\n

\n

The connection type for EnterpriseServerUserAccount.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerUserAccountEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerUserAccount])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerUserAccount)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmail\n

\n

An email belonging to a user account on an Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String!)

The email address.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrimary (Boolean!)

Indicates whether this is the primary email of the associated user account.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

userAccount (EnterpriseServerUserAccount!)

The user account to which the email belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailConnection\n

\n

The connection type for EnterpriseServerUserAccountEmail.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerUserAccountEmailEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerUserAccountEmail])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerUserAccountEmail)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUpload\n

\n

A user accounts upload from an Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise!)

The enterprise to which this upload belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseServerInstallation (EnterpriseServerInstallation!)

The Enterprise Server installation for which this upload was generated.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the file uploaded.

\n\n\n\n\n\n\n\n\n\n\n\n

syncState (EnterpriseServerUserAccountsUploadSyncState!)

The synchronization state of the upload.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadConnection\n

\n

The connection type for EnterpriseServerUserAccountsUpload.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerUserAccountsUploadEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerUserAccountsUpload])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerUserAccountsUpload)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseUserAccount\n

\n

An account for a user who is an admin of an enterprise or a member of an enterprise through one or more organizations.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the enterprise user account's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise!)

The enterprise in which this user account exists.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

An identifier for the enterprise user account, a login or email address.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the enterprise user account.

\n\n\n\n\n\n\n\n\n\n\n\n

organizations (EnterpriseOrganizationMembershipConnection!)

A list of enterprise organizations this user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseUserAccountMembershipRole)

\n

The role of the user in the enterprise organization.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user within the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseUserAccountConnection\n

\n

The connection type for EnterpriseUserAccount.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseUserAccountEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseUserAccount])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseUserAccountEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseUserAccount)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentity\n

\n

An external identity provisioned by SAML SSO or SCIM.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

guid (String!)

The GUID for this identity.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationInvitation (OrganizationInvitation)

Organization invitation for this SCIM-provisioned external identity.

\n\n\n\n\n\n\n\n\n\n\n\n

samlIdentity (ExternalIdentitySamlAttributes)

SAML Identity attributes.

\n\n\n\n\n\n\n\n\n\n\n\n

scimIdentity (ExternalIdentityScimAttributes)

SCIM Identity attributes.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentityConnection\n

\n

The connection type for ExternalIdentity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ExternalIdentityEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ExternalIdentity])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentityEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ExternalIdentity)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentitySamlAttributes\n

\n

SAML attributes for the External Identity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([UserEmailMetadata!])

The emails associated with the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

familyName (String)

Family name of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

givenName (String)

Given name of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

groups ([String!])

The groups linked to this identity in IDP.

\n\n\n\n\n\n\n\n\n\n\n\n

nameId (String)

The NameID of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

username (String)

The userName of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentityScimAttributes\n

\n

SCIM attributes for the External Identity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([UserEmailMetadata!])

The emails associated with the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n

familyName (String)

Family name of the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n

givenName (String)

Given name of the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n

groups ([String!])

The groups linked to this identity in IDP.

\n\n\n\n\n\n\n\n\n\n\n\n

username (String)

The userName of the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n FollowerConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n FollowingConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n FundingLink\n

\n

A funding platform link for a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

platform (FundingPlatform!)

The funding platform this link is for.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The configured URL for this funding link.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GenericHovercardContext\n

\n

A generic hovercard context with a message and icon.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Gist\n

\n

A Gist.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (GistCommentConnection!)

A list of comments associated with the gist.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The gist description.

\n\n\n\n\n\n\n\n\n\n\n\n

files ([GistFile])

The files in this gist.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

limit (Int)

\n

The maximum number of files to return.

\n

The default value is 10.

\n
\n\n
\n

oid (GitObjectID)

\n

The oid of the files to return.

\n\n
\n\n
\n\n\n

forks (GistConnection!)

A list of forks associated with the gist.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (GistOrder)

\n

Ordering options for gists returned from the connection.

\n\n
\n\n
\n\n\n

isFork (Boolean!)

Identifies if the gist is a fork.

\n\n\n\n\n\n\n\n\n\n\n\n

isPublic (Boolean!)

Whether the gist is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The gist name.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (RepositoryOwner)

The gist owner.

\n\n\n\n\n\n\n\n\n\n\n\n

pushedAt (DateTime)

Identifies when the gist was last pushed to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTML path to this resource.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this Gist.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistComment\n

\n

Represents a comment on an Gist.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the gist.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

gist (Gist!)

The associated gist.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistCommentConnection\n

\n

The connection type for GistComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([GistCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([GistComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (GistComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistConnection\n

\n

The connection type for Gist.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([GistEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Gist])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Gist)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistFile\n

\n

A file in a gist.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

encodedName (String)

The file name encoded to remove characters that are invalid in URL paths.

\n\n\n\n\n\n\n\n\n\n\n\n

encoding (String)

The gist file encoding.

\n\n\n\n\n\n\n\n\n\n\n\n

extension (String)

The file extension from the file name.

\n\n\n\n\n\n\n\n\n\n\n\n

isImage (Boolean!)

Indicates if this file is an image.

\n\n\n\n\n\n\n\n\n\n\n\n

isTruncated (Boolean!)

Whether the file's contents were truncated.

\n\n\n\n\n\n\n\n\n\n\n\n

language (Language)

The programming language this file is written in.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The gist file name.

\n\n\n\n\n\n\n\n\n\n\n\n

size (Int)

The gist file size in bytes.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

UTF8 text data or null if the file is binary.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

truncate (Int)

\n

Optionally truncate the returned file to this length.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitActor\n

\n

Represents an actor in a Git commit (ie. an author or committer).

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the author's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

date (GitTimestamp)

The timestamp of the Git action (authoring or committing).

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email in the Git commit.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name in the Git commit.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The GitHub user corresponding to the email field. Null if no such user exists.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitActorConnection\n

\n

The connection type for GitActor.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([GitActorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([GitActor])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitActorEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (GitActor)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitHubMetadata\n

\n

Represents information about the GitHub instance.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

gitHubServicesSha (GitObjectID!)

Returns a String that's a SHA of github-services.

\n\n\n\n\n\n\n\n\n\n\n\n

gitIpAddresses ([String!])

IP addresses that users connect to for git operations.

\n\n\n\n\n\n\n\n\n\n\n\n

hookIpAddresses ([String!])

IP addresses that service hooks are sent from.

\n\n\n\n\n\n\n\n\n\n\n\n

importerIpAddresses ([String!])

IP addresses that the importer connects from.

\n\n\n\n\n\n\n\n\n\n\n\n

isPasswordAuthenticationVerifiable (Boolean!)

Whether or not users are verified.

\n\n\n\n\n\n\n\n\n\n\n\n

pagesIpAddresses ([String!])

IP addresses for GitHub Pages' A records.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GpgSignature\n

\n

Represents a GPG signature on a Commit or Tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String!)

Email used to sign this object.

\n\n\n\n\n\n\n\n\n\n\n\n

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

keyId (String)

Hex-encoded ID of the key that signed this object.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (String!)

ASCII-armored signature header from object.

\n\n\n\n\n\n\n\n\n\n\n\n

signer (User)

GitHub user corresponding to the email signing this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

\n\n\n\n\n\n\n\n\n\n\n\n

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n HeadRefDeletedEvent\n

\n

Represents ahead_ref_deletedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

headRef (Ref)

Identifies the Ref associated with the head_ref_deleted event.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

Identifies the name of the Ref associated with the head_ref_deleted event.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n HeadRefForcePushedEvent\n

\n

Represents ahead_ref_force_pushedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

afterCommit (Commit)

Identifies the after commit SHA for thehead_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeCommit (Commit)

Identifies the before commit SHA for thehead_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the fully qualified ref name for thehead_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n HeadRefRestoredEvent\n

\n

Represents ahead_ref_restoredevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Hovercard\n

\n

Detail needed to display a hovercard for a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

contexts ([HovercardContext!]!)

Each of the contexts for this hovercard.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IpAllowListEntry\n

\n

An IP address or range of addresses that is allowed to access an owner's resources.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

A single IP address or range of IP addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the entry is currently active.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (IpAllowListOwner!)

The owner of the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryConnection\n

\n

The connection type for IpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IpAllowListEntryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IpAllowListEntry])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IpAllowListEntry)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Issue\n

\n

An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

activeLockReason (LockReason)

Reason that the conversation was locked.

\n\n\n\n\n\n\n\n\n\n\n\n

assignees (UserConnection!)

A list of Users assigned to this object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the body of the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyResourcePath (URI!)

The http path for this issue body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

Identifies the body of the issue rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyUrl (URI!)

The http URL for this issue body.

\n\n\n\n\n\n\n\n\n\n\n\n

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (IssueCommentConnection!)

A list of comments associated with the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueCommentOrder)

\n

Ordering options for issue comments returned from the connection.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

hovercard (Hovercard!)

The hovercard information for this issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

includeNotificationContexts (Boolean)

\n

Whether or not to include notification contexts.

\n

The default value is true.

\n
\n\n
\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isReadByViewer (Boolean)

Is this issue read by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

labels (LabelConnection)

A list of labels associated with the object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

locked (Boolean!)

true if the object is locked.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (Milestone)

Identifies the milestone associated with the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the issue number.

\n\n\n\n\n\n\n\n\n\n\n\n

participants (UserConnection!)

A list of Users that are participating in the Issue conversation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

projectCards (ProjectCardConnection!)

List of project cards associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

state (IssueState!)

Identifies the state of the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

timeline (IssueTimelineConnection!)

A list of events, comments, commits, etc. associated with the issue.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

timeline is deprecated.

timeline will be removed Use Issue.timelineItems instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Allows filtering timeline events by a since timestamp.

\n\n
\n\n
\n\n\n

timelineItems (IssueTimelineItemsConnection!)

A list of events, comments, commits, etc. associated with the issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

itemTypes ([IssueTimelineItemsItemType!])

\n

Filter timeline items by type.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Filter timeline items by a since timestamp.

\n\n
\n\n
\n

skip (Int)

\n

Skips the first n elements in the list.

\n\n
\n\n
\n\n\n

title (String!)

Identifies the issue title.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueComment\n

\n

Represents a comment on an Issue.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

Returns the pull request associated with the comment, if this comment was made on a\npull request.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this issue comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this issue comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueCommentConnection\n

\n

The connection type for IssueComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IssueComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IssueComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueConnection\n

\n

The connection type for Issue.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Issue])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueContributionsByRepository\n

\n

This aggregates issues opened by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedIssueContributionConnection!)

The issue contributions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the issues were opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Issue)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTemplate\n

\n

A repository issue template.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

about (String)

The template purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The suggested issue body.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The template name.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The suggested issue title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineConnection\n

\n

The connection type for IssueTimelineItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueTimelineItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IssueTimelineItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IssueTimelineItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineItemsConnection\n

\n

The connection type for IssueTimelineItems.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueTimelineItemsEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

filteredCount (Int!)

Identifies the count of items after applying before and after filters.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IssueTimelineItems])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageCount (Int!)

Identifies the count of items after applying before/after filters and first/last/skip slicing.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the timeline was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineItemsEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IssueTimelineItems)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n JoinedGitHubContribution\n

\n

Represents a user signing up for a GitHub account.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Label\n

\n

A label for categorizing Issues or Milestones with a given Repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

color (String!)

Identifies the label color.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime)

Identifies the date and time when the label was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of this label.

\n\n\n\n\n\n\n\n\n\n\n\n

isDefault (Boolean!)

Indicates whether or not this is a default label.

\n\n\n\n\n\n\n\n\n\n\n\n

issues (IssueConnection!)

A list of issues associated with this label.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

name (String!)

Identifies the label name.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests associated with this label.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this label.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this label.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime)

Identifies the date and time when the label was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LabelConnection\n

\n

The connection type for Label.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([LabelEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Label])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LabelEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Label)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LabeledEvent\n

\n

Represents alabeledevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

label (Label!)

Identifies the label associated with thelabeledevent.

\n\n\n\n\n\n\n\n\n\n\n\n

labelable (Labelable!)

Identifies the Labelable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Language\n

\n

Represents a given language found in repositories.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

color (String)

The color defined for the current language.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the current language.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LanguageConnection\n

\n

A list of languages associated with the parent.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([LanguageEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Language])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalSize (Int!)

The total size in bytes of files written in that language.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LanguageEdge\n

\n

Represents the language of a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

size (Int!)

The number of bytes of code written in the language.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n License\n

\n

A repository's open source license.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The full text of the license.

\n\n\n\n\n\n\n\n\n\n\n\n

conditions ([LicenseRule]!)

The conditions set by the license.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A human-readable description of the license.

\n\n\n\n\n\n\n\n\n\n\n\n

featured (Boolean!)

Whether the license should be featured.

\n\n\n\n\n\n\n\n\n\n\n\n

hidden (Boolean!)

Whether the license should be displayed in license pickers.

\n\n\n\n\n\n\n\n\n\n\n\n

implementation (String)

Instructions on how to implement the license.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The lowercased SPDX ID of the license.

\n\n\n\n\n\n\n\n\n\n\n\n

limitations ([LicenseRule]!)

The limitations set by the license.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The license full name specified by https://spdx.org/licenses.

\n\n\n\n\n\n\n\n\n\n\n\n

nickname (String)

Customary short name if applicable (e.g, GPLv3).

\n\n\n\n\n\n\n\n\n\n\n\n

permissions ([LicenseRule]!)

The permissions set by the license.

\n\n\n\n\n\n\n\n\n\n\n\n

pseudoLicense (Boolean!)

Whether the license is a pseudo-license placeholder (e.g., other, no-license).

\n\n\n\n\n\n\n\n\n\n\n\n

spdxId (String)

Short identifier specified by https://spdx.org/licenses.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI)

URL to the license on https://choosealicense.com.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LicenseRule\n

\n

Describes a License's conditions, permissions, and limitations.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String!)

A description of the rule.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The machine-readable rule key.

\n\n\n\n\n\n\n\n\n\n\n\n

label (String!)

The human-readable rule label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LockedEvent\n

\n

Represents alockedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (LockReason)

Reason that the conversation was locked (optional).

\n\n\n\n\n\n\n\n\n\n\n\n

lockable (Lockable!)

Object that was locked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Mannequin\n

\n

A placeholder user for attribution of imported data on GitHub.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the GitHub App's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The mannequin's email on the source instance.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The username of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTML path to this resource.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The URL to this resource.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MarkedAsDuplicateEvent\n

\n

Represents amarked_as_duplicateevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

canonical (IssueOrPullRequest)

The authoritative issue or pull request which has been duplicated by another.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicate (IssueOrPullRequest)

The issue or pull request which has been marked as a duplicate of another.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Canonical and duplicate belong to different repositories.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MarketplaceCategory\n

\n

A public description of a Marketplace category.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String)

The category's description.

\n\n\n\n\n\n\n\n\n\n\n\n

howItWorks (String)

The technical description of how apps listed in this category work with GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The category's name.

\n\n\n\n\n\n\n\n\n\n\n\n

primaryListingCount (Int!)

How many Marketplace listings have this as their primary category.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this Marketplace category.

\n\n\n\n\n\n\n\n\n\n\n\n

secondaryListingCount (Int!)

How many Marketplace listings have this as their secondary category.

\n\n\n\n\n\n\n\n\n\n\n\n

slug (String!)

The short name of the category used in its URL.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this Marketplace category.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MarketplaceListing\n

\n

A listing in the GitHub integration marketplace.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

app (App)

The GitHub App this listing represents.

\n\n\n\n\n\n\n\n\n\n\n\n

companyUrl (URI)

URL to the listing owner's company site.

\n\n\n\n\n\n\n\n\n\n\n\n

configurationResourcePath (URI!)

The HTTP path for configuring access to the listing's integration or OAuth app.

\n\n\n\n\n\n\n\n\n\n\n\n

configurationUrl (URI!)

The HTTP URL for configuring access to the listing's integration or OAuth app.

\n\n\n\n\n\n\n\n\n\n\n\n

documentationUrl (URI)

URL to the listing's documentation.

\n\n\n\n\n\n\n\n\n\n\n\n

extendedDescription (String)

The listing's detailed description.

\n\n\n\n\n\n\n\n\n\n\n\n

extendedDescriptionHTML (HTML!)

The listing's detailed description rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

fullDescription (String!)

The listing's introductory description.

\n\n\n\n\n\n\n\n\n\n\n\n

fullDescriptionHTML (HTML!)

The listing's introductory description rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

hasPublishedFreeTrialPlans (Boolean!)

Does this listing have any plans with a free trial?.

\n\n\n\n\n\n\n\n\n\n\n\n

hasTermsOfService (Boolean!)

Does this listing have a terms of service link?.

\n\n\n\n\n\n\n\n\n\n\n\n

hasVerifiedOwner (Boolean!)

Whether the creator of the app is a verified org.

\n\n\n\n\n\n\n\n\n\n\n\n

howItWorks (String)

A technical description of how this app works with GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

howItWorksHTML (HTML!)

The listing's technical description rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

installationUrl (URI)

URL to install the product to the viewer's account or organization.

\n\n\n\n\n\n\n\n\n\n\n\n

installedForViewer (Boolean!)

Whether this listing's app has been installed for the current viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean!)

Whether this listing has been removed from the Marketplace.

\n\n\n\n\n\n\n\n\n\n\n\n

isDraft (Boolean!)

Whether this listing is still an editable draft that has not been submitted\nfor review and is not publicly visible in the Marketplace.

\n\n\n\n\n\n\n\n\n\n\n\n

isPaid (Boolean!)

Whether the product this listing represents is available as part of a paid plan.

\n\n\n\n\n\n\n\n\n\n\n\n

isPublic (Boolean!)

Whether this listing has been approved for display in the Marketplace.

\n\n\n\n\n\n\n\n\n\n\n\n

isRejected (Boolean!)

Whether this listing has been rejected by GitHub for display in the Marketplace.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnverified (Boolean!)

Whether this listing has been approved for unverified display in the Marketplace.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnverifiedPending (Boolean!)

Whether this draft listing has been submitted for review for approval to be unverified in the Marketplace.

\n\n\n\n\n\n\n\n\n\n\n\n

isVerificationPendingFromDraft (Boolean!)

Whether this draft listing has been submitted for review from GitHub for approval to be verified in the Marketplace.

\n\n\n\n\n\n\n\n\n\n\n\n

isVerificationPendingFromUnverified (Boolean!)

Whether this unverified listing has been submitted for review from GitHub for approval to be verified in the Marketplace.

\n\n\n\n\n\n\n\n\n\n\n\n

isVerified (Boolean!)

Whether this listing has been approved for verified display in the Marketplace.

\n\n\n\n\n\n\n\n\n\n\n\n

logoBackgroundColor (String!)

The hex color code, without the leading '#', for the logo background.

\n\n\n\n\n\n\n\n\n\n\n\n

logoUrl (URI)

URL for the listing's logo image.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size in pixels of the resulting square image.

\n

The default value is 400.

\n
\n\n
\n\n\n

name (String!)

The listing's full name.

\n\n\n\n\n\n\n\n\n\n\n\n

normalizedShortDescription (String!)

The listing's very short description without a trailing period or ampersands.

\n\n\n\n\n\n\n\n\n\n\n\n

pricingUrl (URI)

URL to the listing's detailed pricing.

\n\n\n\n\n\n\n\n\n\n\n\n

primaryCategory (MarketplaceCategory!)

The category that best describes the listing.

\n\n\n\n\n\n\n\n\n\n\n\n

privacyPolicyUrl (URI!)

URL to the listing's privacy policy, may return an empty string for listings that do not require a privacy policy URL.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for the Marketplace listing.

\n\n\n\n\n\n\n\n\n\n\n\n

screenshotUrls ([String]!)

The URLs for the listing's screenshots.

\n\n\n\n\n\n\n\n\n\n\n\n

secondaryCategory (MarketplaceCategory)

An alternate category that describes the listing.

\n\n\n\n\n\n\n\n\n\n\n\n

shortDescription (String!)

The listing's very short description.

\n\n\n\n\n\n\n\n\n\n\n\n

slug (String!)

The short name of the listing used in its URL.

\n\n\n\n\n\n\n\n\n\n\n\n

statusUrl (URI)

URL to the listing's status page.

\n\n\n\n\n\n\n\n\n\n\n\n

supportEmail (String)

An email address for support for this listing's app.

\n\n\n\n\n\n\n\n\n\n\n\n

supportUrl (URI!)

Either a URL or an email address for support for this listing's app, may\nreturn an empty string for listings that do not require a support URL.

\n\n\n\n\n\n\n\n\n\n\n\n

termsOfServiceUrl (URI)

URL to the listing's terms of service.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for the Marketplace listing.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAddPlans (Boolean!)

Can the current viewer add plans for this Marketplace listing.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanApprove (Boolean!)

Can the current viewer approve this Marketplace listing.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanDelist (Boolean!)

Can the current viewer delist this Marketplace listing.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanEdit (Boolean!)

Can the current viewer edit this Marketplace listing.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanEditCategories (Boolean!)

Can the current viewer edit the primary and secondary category of this\nMarketplace listing.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanEditPlans (Boolean!)

Can the current viewer edit the plans for this Marketplace listing.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanRedraft (Boolean!)

Can the current viewer return this Marketplace listing to draft state\nso it becomes editable again.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReject (Boolean!)

Can the current viewer reject this Marketplace listing by returning it to\nan editable draft state or rejecting it entirely.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanRequestApproval (Boolean!)

Can the current viewer request this listing be reviewed for display in\nthe Marketplace as verified.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasPurchased (Boolean!)

Indicates whether the current user has an active subscription to this Marketplace listing.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasPurchasedForAllOrganizations (Boolean!)

Indicates if the current user has purchased a subscription to this Marketplace listing\nfor all of the organizations the user owns.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerIsListingAdmin (Boolean!)

Does the current viewer role allow them to administer this Marketplace listing.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MarketplaceListingConnection\n

\n

Look up Marketplace Listings.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([MarketplaceListingEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([MarketplaceListing])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MarketplaceListingEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (MarketplaceListing)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MembersCanDeleteReposClearAuditEntry\n

\n

Audit log entry for a members_can_delete_repos.clear event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MembersCanDeleteReposDisableAuditEntry\n

\n

Audit log entry for a members_can_delete_repos.disable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MembersCanDeleteReposEnableAuditEntry\n

\n

Audit log entry for a members_can_delete_repos.enable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MentionedEvent\n

\n

Represents amentionedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MergedEvent\n

\n

Represents amergedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with the merge event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeRef (Ref)

Identifies the Ref associated with the merge event.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeRefName (String!)

Identifies the name of the Ref associated with the merge event.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this merged event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this merged event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Milestone\n

\n

Represents a Milestone object on a given repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

Identifies the actor who created the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Identifies the description of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

dueOn (DateTime)

Identifies the due date of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

issues (IssueConnection!)

A list of issues associated with the milestone.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

number (Int!)

Identifies the number of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

progressPercentage (Float!)

Identifies the percentage complete for the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests associated with the milestone.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

state (MilestoneState!)

Identifies the state of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

Identifies the title of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this milestone.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MilestoneConnection\n

\n

The connection type for Milestone.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([MilestoneEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Milestone])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MilestoneEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Milestone)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MilestonedEvent\n

\n

Represents amilestonedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneTitle (String!)

Identifies the milestone title associated with themilestonedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (MilestoneItem!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MovedColumnsInProjectEvent\n

\n

Represents amoved_columns_in_projectevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

previousProjectColumnName (String!)

Column name the issue or pull request was moved from.

\n\n\n\n\n
\n

Preview notice

\n

previousProjectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectCard (ProjectCard)

Project card referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name the issue or pull request was moved to.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OauthApplicationCreateAuditEntry\n

\n

Audit log entry for a oauth_application.create event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

applicationUrl (URI)

The application URL of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

callbackUrl (URI)

The callback URL of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

rateLimit (Int)

The rate limit of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

state (OauthApplicationCreateAuditEntryState)

The state of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgAddBillingManagerAuditEntry\n

\n

Audit log entry for a org.add_billing_manager.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationEmail (String)

The email address used to invite a billing manager for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgAddMemberAuditEntry\n

\n

Audit log entry for a org.add_member.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (OrgAddMemberAuditEntryPermission)

The permission level of the member added to the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgBlockUserAuditEntry\n

\n

Audit log entry for a org.block_user.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUser (User)

The blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserName (String)

The username of the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserResourcePath (URI)

The HTTP path for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserUrl (URI)

The HTTP URL for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgConfigDisableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a org.config.disable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgConfigEnableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a org.config.enable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgCreateAuditEntry\n

\n

Audit log entry for a org.create event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

billingPlan (OrgCreateAuditEntryBillingPlan)

The billing plan for the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgDisableOauthAppRestrictionsAuditEntry\n

\n

Audit log entry for a org.disable_oauth_app_restrictions event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgDisableSamlAuditEntry\n

\n

Audit log entry for a org.disable_saml event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

digestMethodUrl (URI)

The SAML provider's digest algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

issuerUrl (URI)

The SAML provider's issuer URL.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethodUrl (URI)

The SAML provider's signature algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

singleSignOnUrl (URI)

The SAML provider's single sign-on URL.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgDisableTwoFactorRequirementAuditEntry\n

\n

Audit log entry for a org.disable_two_factor_requirement event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgEnableOauthAppRestrictionsAuditEntry\n

\n

Audit log entry for a org.enable_oauth_app_restrictions event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgEnableSamlAuditEntry\n

\n

Audit log entry for a org.enable_saml event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

digestMethodUrl (URI)

The SAML provider's digest algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

issuerUrl (URI)

The SAML provider's issuer URL.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethodUrl (URI)

The SAML provider's signature algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

singleSignOnUrl (URI)

The SAML provider's single sign-on URL.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgEnableTwoFactorRequirementAuditEntry\n

\n

Audit log entry for a org.enable_two_factor_requirement event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgInviteMemberAuditEntry\n

\n

Audit log entry for a org.invite_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email address of the organization invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationInvitation (OrganizationInvitation)

The organization invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgInviteToBusinessAuditEntry\n

\n

Audit log entry for a org.invite_to_business event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgOauthAppAccessApprovedAuditEntry\n

\n

Audit log entry for a org.oauth_app_access_approved event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgOauthAppAccessDeniedAuditEntry\n

\n

Audit log entry for a org.oauth_app_access_denied event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgOauthAppAccessRequestedAuditEntry\n

\n

Audit log entry for a org.oauth_app_access_requested event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRemoveBillingManagerAuditEntry\n

\n

Audit log entry for a org.remove_billing_manager event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (OrgRemoveBillingManagerAuditEntryReason)

The reason for the billing manager being removed.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRemoveMemberAuditEntry\n

\n

Audit log entry for a org.remove_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

membershipTypes ([OrgRemoveMemberAuditEntryMembershipType!])

The types of membership the member has with the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (OrgRemoveMemberAuditEntryReason)

The reason for the member being removed.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRemoveOutsideCollaboratorAuditEntry\n

\n

Audit log entry for a org.remove_outside_collaborator event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

membershipTypes ([OrgRemoveOutsideCollaboratorAuditEntryMembershipType!])

The types of membership the outside collaborator has with the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (OrgRemoveOutsideCollaboratorAuditEntryReason)

The reason for the outside collaborator being removed from the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberAuditEntry\n

\n

Audit log entry for a org.restore_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredCustomEmailRoutingsCount (Int)

The number of custom email routings for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredIssueAssignmentsCount (Int)

The number of issue assignments for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredMemberships ([OrgRestoreMemberAuditEntryMembership!])

Restored organization membership objects.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredMembershipsCount (Int)

The number of restored memberships.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredRepositoriesCount (Int)

The number of repositories of the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredRepositoryStarsCount (Int)

The number of starred repositories for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredRepositoryWatchesCount (Int)

The number of watched repositories for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberMembershipOrganizationAuditEntryData\n

\n

Metadata for an organization membership for org.restore_member actions.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberMembershipRepositoryAuditEntryData\n

\n

Metadata for a repository membership for org.restore_member actions.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberMembershipTeamAuditEntryData\n

\n

Metadata for a team membership for org.restore_member actions.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUnblockUserAuditEntry\n

\n

Audit log entry for a org.unblock_user.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUser (User)

The user being unblocked by the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserName (String)

The username of the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserResourcePath (URI)

The HTTP path for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserUrl (URI)

The HTTP URL for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateDefaultRepositoryPermissionAuditEntry\n

\n

Audit log entry for a org.update_default_repository_permission.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

The new default repository permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permissionWas (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

The former default repository permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateMemberAuditEntry\n

\n

Audit log entry for a org.update_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (OrgUpdateMemberAuditEntryPermission)

The new member permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permissionWas (OrgUpdateMemberAuditEntryPermission)

The former member permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateMemberRepositoryCreationPermissionAuditEntry\n

\n

Audit log entry for a org.update_member_repository_creation_permission event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

canCreateRepositories (Boolean)

Can members create repositories in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility)

The permission for visibility level of repositories for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateMemberRepositoryInvitationPermissionAuditEntry\n

\n

Audit log entry for a org.update_member_repository_invitation_permission event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

canInviteOutsideCollaboratorsToRepositories (Boolean)

Can outside collaborators be invited to repositories in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Organization\n

\n

An account on GitHub, with one or more owners, that has repositories, members and teams.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

anyPinnableItems (Boolean!)

Determine if this repository owner has any items that can be pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

type (PinnableItemType)

\n

Filter to only a particular kind of pinnable item.

\n\n
\n\n
\n\n\n

auditLog (OrganizationAuditEntryConnection!)

Audit log entries of the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (AuditLogOrder)

\n

Ordering options for the returned audit log entries.

\n\n
\n\n
\n

query (String)

\n

The query string to filter audit entries.

\n\n
\n\n
\n\n\n

avatarUrl (URI!)

A URL pointing to the organization's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The organization's public profile description.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (String)

The organization's public profile description rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

domains (VerifiableDomainConnection)

A list of domains owned by the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isVerified (Boolean)

\n

Filter by if the domain is verified.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (VerifiableDomainOrder)

\n

Ordering options for verifiable domains returned.

\n\n
\n\n
\n\n\n

email (String)

The organization's public email.

\n\n\n\n\n\n\n\n\n\n\n\n

hasSponsorsListing (Boolean!)

True if this user/organization has a GitHub Sponsors listing.

\n\n\n\n\n\n\n\n\n\n\n\n

interactionAbility (RepositoryInteractionAbility)

The interaction ability settings for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

The setting value for whether the organization has an IP allow list enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntries (IpAllowListEntryConnection!)

The IP addresses that are allowed to access resources owned by the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IpAllowListEntryOrder)

\n

Ordering options for IP allow list entries returned.

\n\n
\n\n
\n\n\n

isSponsoredBy (Boolean!)

Check if the given account is sponsoring this user/organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

accountLogin (String!)

\n

The target account's login.

\n\n
\n\n
\n\n\n

isSponsoringViewer (Boolean!)

True if the viewer is sponsored by this user/organization.

\n\n\n\n\n\n\n\n\n\n\n\n

isVerified (Boolean!)

Whether the organization has verified its profile email and website, always false on Enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

itemShowcase (ProfileItemShowcase!)

Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The organization's public profile location.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The organization's login name.

\n\n\n\n\n\n\n\n\n\n\n\n

memberStatuses (UserStatusConnection!)

Get the status messages members of this entity have set that are either public or visible only to the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (UserStatusOrder)

\n

Ordering options for user statuses returned from the connection.

\n\n
\n\n
\n\n\n

membersWithRole (OrganizationMemberConnection!)

A list of users who are members of this organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

name (String)

The organization's public profile name.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamResourcePath (URI!)

The HTTP path creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamUrl (URI!)

The HTTP URL creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

notificationDeliveryRestrictionEnabledSetting (NotificationRestrictionSettingValue!)

Indicates if email notification delivery for this organization is restricted to verified domains.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationBillingEmail (String)

The billing email for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

packages (PackageConnection!)

A list of packages under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

names ([String])

\n

Find packages by their names.

\n\n
\n\n
\n

orderBy (PackageOrder)

\n

Ordering of the returned packages.

\n\n
\n\n
\n

packageType (PackageType)

\n

Filter registry package by type.

\n\n
\n\n
\n

repositoryId (ID)

\n

Find packages in a repository by ID.

\n\n
\n\n
\n\n\n

pendingMembers (UserConnection!)

A list of users who have been invited to join this organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pinnableItems (PinnableItemConnection!)

A list of repositories and gists this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinnable items that are returned.

\n\n
\n\n
\n\n\n

pinnedItems (PinnableItemConnection!)

A list of repositories and gists this profile owner has pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinned items that are returned.

\n\n
\n\n
\n\n\n

pinnedItemsRemaining (Int!)

Returns how many more items this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Find project by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The project number to find.

\n\n
\n\n
\n\n\n

projects (ProjectConnection!)

A list of projects under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ProjectOrder)

\n

Ordering options for projects returned from the connection.

\n\n
\n\n
\n

search (String)

\n

Query to search projects by, currently only searching by name.

\n\n
\n\n
\n

states ([ProjectState!])

\n

A list of states to filter the projects by.

\n\n
\n\n
\n\n\n

projectsResourcePath (URI!)

The HTTP path listing organization's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

projectsUrl (URI!)

The HTTP URL listing organization's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (RepositoryConnection!)

A list of repositories that the user owns.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isFork (Boolean)

\n

If non-null, filters repositories according to whether they are forks of another repository.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

repository (Repository)

Find Repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

Name of Repository to find.

\n\n
\n\n
\n\n\n

requiresTwoFactorAuthentication (Boolean)

When true the organization requires all members, billing managers, and outside\ncollaborators to enable two-factor authentication.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

samlIdentityProvider (OrganizationIdentityProvider)

The Organization's SAML identity providers.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorsListing (SponsorsListing)

The GitHub Sponsors listing for this user or organization.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorshipForViewerAsSponsor (Sponsorship)

The viewer's sponsorship of this entity.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorshipsAsMaintainer (SponsorshipConnection!)

This object's sponsorships as the maintainer.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includePrivate (Boolean)

\n

Whether or not to include private sponsorships in the result set.

\n

The default value is false.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

sponsorshipsAsSponsor (SponsorshipConnection!)

This object's sponsorships as the sponsor.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

team (Team)

Find an organization's team by its slug.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

slug (String!)

\n

The name or slug of the team to find.

\n\n
\n\n
\n\n\n

teams (TeamConnection!)

A list of teams in this organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

ldapMapped (Boolean)

\n

If true, filters teams that are mapped to an LDAP Group (Enterprise only).

\n\n
\n\n
\n

orderBy (TeamOrder)

\n

Ordering options for teams returned from the connection.

\n\n
\n\n
\n

privacy (TeamPrivacy)

\n

If non-null, filters teams according to privacy.

\n\n
\n\n
\n

query (String)

\n

If non-null, filters teams with query on team name and team slug.

\n\n
\n\n
\n

role (TeamRole)

\n

If non-null, filters teams according to whether the viewer is an admin or member on team.

\n\n
\n\n
\n

rootTeamsOnly (Boolean)

\n

If true, restrict to only root teams.

\n

The default value is false.

\n
\n\n
\n

userLogins ([String!])

\n

User logins to filter by.

\n\n
\n\n
\n\n\n

teamsResourcePath (URI!)

The HTTP path listing organization's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsUrl (URI!)

The HTTP URL listing organization's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

twitterUsername (String)

The organization's Twitter username.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAdminister (Boolean!)

Organization is adminable by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanChangePinnedItems (Boolean!)

Can the viewer pin repositories and gists to the profile?.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateRepositories (Boolean!)

Viewer can create repositories on this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateTeams (Boolean!)

Viewer can create teams on this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSponsor (Boolean!)

Whether or not the viewer is able to sponsor this user/organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerIsAMember (Boolean!)

Viewer is an active member of this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerIsSponsoring (Boolean!)

True if the viewer is sponsoring this user/organization.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (URI)

The organization's public profile URL.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationAuditEntryConnection\n

\n

The connection type for OrganizationAuditEntry.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationAuditEntryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([OrganizationAuditEntry])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationAuditEntryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (OrganizationAuditEntry)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationConnection\n

\n

The connection type for Organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Organization])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Organization)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationIdentityProvider\n

\n

An Identity Provider configured to provision SAML and SCIM identities for Organizations.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

digestMethod (URI)

The digest algorithm used to sign SAML requests for the Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n\n

externalIdentities (ExternalIdentityConnection!)

External Identities provisioned by this Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

idpCertificate (X509Certificate)

The x509 certificate used by the Identity Provider to sign assertions and responses.

\n\n\n\n\n\n\n\n\n\n\n\n

issuer (String)

The Issuer Entity ID for the SAML Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

Organization this Identity Provider belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethod (URI)

The signature algorithm used to sign SAML requests for the Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n\n

ssoUrl (URI)

The URL endpoint for the Identity Provider's SAML SSO.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationInvitation\n

\n

An Invitation for a user to an organization.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email address of the user invited to the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationType (OrganizationInvitationType!)

The type of invitation that was sent (e.g. email, user).

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (User)

The user who was invited to the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

inviter (User!)

The user who created the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization!)

The organization the invite is for.

\n\n\n\n\n\n\n\n\n\n\n\n

role (OrganizationInvitationRole!)

The user's pending role in the organization (e.g. member, owner).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationInvitationConnection\n

\n

The connection type for OrganizationInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([OrganizationInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationInvitationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (OrganizationInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationMemberConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationMemberEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationMemberEdge\n

\n

Represents a user within an organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

hasTwoFactorEnabled (Boolean)

Whether the organization member has two factor enabled or not. Returns null if information is not available to viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

role (OrganizationMemberRole)

The role this user has in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationTeamsHovercardContext\n

\n

An organization teams hovercard context.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

relevantTeams (TeamConnection!)

Teams in this organization the user is a member of that are relevant.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

teamsResourcePath (URI!)

The path for the full team list for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsUrl (URI!)

The URL for the full team list for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

totalTeamCount (Int!)

The total number of teams the user is on in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationsHovercardContext\n

\n

An organization list hovercard context.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

relevantOrganizations (OrganizationConnection!)

Organizations this user is a member of that are relevant.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

totalOrganizationCount (Int!)

The total number of organizations this user is in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Package\n

\n

Information for an uploaded package.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

latestVersion (PackageVersion)

Find the latest version for the package.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Identifies the name of the package.

\n\n\n\n\n\n\n\n\n\n\n\n

packageType (PackageType!)

Identifies the type of the package.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository this package belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

statistics (PackageStatistics)

Statistics about package activity.

\n\n\n\n\n\n\n\n\n\n\n\n

version (PackageVersion)

Find package version by version string.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

version (String!)

\n

The package version.

\n\n
\n\n
\n\n\n

versions (PackageVersionConnection!)

list of versions for this package.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (PackageVersionOrder)

\n

Ordering of the returned packages.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageConnection\n

\n

The connection type for Package.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PackageEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Package])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Package)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageFile\n

\n

A file in a package version.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

md5 (String)

MD5 hash of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Name of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

packageVersion (PackageVersion)

The package version this file belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

sha1 (String)

SHA1 hash of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

sha256 (String)

SHA256 hash of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

size (Int)

Size of the file in bytes.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI)

URL to download the asset.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageFileConnection\n

\n

The connection type for PackageFile.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PackageFileEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PackageFile])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageFileEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PackageFile)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageStatistics\n

\n

Represents a object that contains package activity statistics such as downloads.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

downloadsTotalCount (Int!)

Number of times the package was downloaded since it was created.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageTag\n

\n

A version tag contains the mapping between a tag name and a version.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

name (String!)

Identifies the tag name of the version.

\n\n\n\n\n\n\n\n\n\n\n\n

version (PackageVersion)

Version that the tag is associated with.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageVersion\n

\n

Information about a specific package version.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

files (PackageFileConnection!)

List of files associated with this package version.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (PackageFileOrder)

\n

Ordering of the returned package files.

\n\n
\n\n
\n\n\n

package (Package)

The package associated with this version.

\n\n\n\n\n\n\n\n\n\n\n\n

platform (String)

The platform this version was built for.

\n\n\n\n\n\n\n\n\n\n\n\n

preRelease (Boolean!)

Whether or not this version is a pre-release.

\n\n\n\n\n\n\n\n\n\n\n\n

readme (String)

The README of this package version.

\n\n\n\n\n\n\n\n\n\n\n\n

release (Release)

The release associated with this package version.

\n\n\n\n\n\n\n\n\n\n\n\n

statistics (PackageVersionStatistics)

Statistics about package activity.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String)

The package version summary.

\n\n\n\n\n\n\n\n\n\n\n\n

version (String!)

The version string.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageVersionConnection\n

\n

The connection type for PackageVersion.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PackageVersionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PackageVersion])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageVersionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PackageVersion)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageVersionStatistics\n

\n

Represents a object that contains package version activity statistics such as downloads.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

downloadsTotalCount (Int!)

Number of times the package was downloaded since it was created.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PageInfo\n

\n

Information about pagination in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

endCursor (String)

When paginating forwards, the cursor to continue.

\n\n\n\n\n\n\n\n\n\n\n\n

hasNextPage (Boolean!)

When paginating forwards, are there more items?.

\n\n\n\n\n\n\n\n\n\n\n\n

hasPreviousPage (Boolean!)

When paginating backwards, are there more items?.

\n\n\n\n\n\n\n\n\n\n\n\n

startCursor (String)

When paginating backwards, the cursor to continue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PermissionSource\n

\n

A level of permission and source for a user's access to a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

organization (Organization!)

The organization the repository belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (DefaultRepositoryPermissionField!)

The level of access this source has granted to the user.

\n\n\n\n\n\n\n\n\n\n\n\n

source (PermissionGranter!)

The source of this permission.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnableItemConnection\n

\n

The connection type for PinnableItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PinnableItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PinnableItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnableItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PinnableItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedEvent\n

\n

Represents apinnedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedIssue\n

\n

A Pinned Issue is a issue pinned to a repository's index page.

\n
\n\n
\n \n
\n

Preview notice

\n

PinnedIssue is available under the Pinned issues preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

The issue that was pinned.

\n\n\n\n\n\n\n\n\n\n\n\n

pinnedBy (Actor!)

The actor that pinned this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository that this issue was pinned to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedIssueConnection\n

\n

The connection type for PinnedIssue.

\n
\n\n
\n \n
\n

Preview notice

\n

PinnedIssueConnection is available under the Pinned issues preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PinnedIssueEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PinnedIssue])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedIssueEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n
\n

Preview notice

\n

PinnedIssueEdge is available under the Pinned issues preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PinnedIssue)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PrivateRepositoryForkingDisableAuditEntry\n

\n

Audit log entry for a private_repository_forking.disable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PrivateRepositoryForkingEnableAuditEntry\n

\n

Audit log entry for a private_repository_forking.enable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProfileItemShowcase\n

\n

A curatable list of repositories relating to a repository owner, which defaults\nto showing the most popular repositories they own.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

hasPinnedItems (Boolean!)

Whether or not the owner has pinned any repositories or gists.

\n\n\n\n\n\n\n\n\n\n\n\n

items (PinnableItemConnection!)

The repositories and gists in the showcase. If the profile owner has any\npinned items, those will be returned. Otherwise, the profile owner's popular\nrepositories will be returned.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Project\n

\n

Projects manage issues, pull requests and notes within a project owner.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The project's description body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The projects description body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

columns (ProjectColumnConnection!)

List of columns in the project.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

The actor who originally created the project.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The project's name.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

The project's number.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (ProjectOwner!)

The project's owner. Currently limited to repositories, organizations, and users.

\n\n\n\n\n\n\n\n\n\n\n\n

pendingCards (ProjectCardConnection!)

List of pending cards in this project.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

progress (ProjectProgress!)

Project progress details.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this project.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectState!)

Whether the project is open or closed.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this project.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectCard\n

\n

A card in a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

column (ProjectColumn)

The project column this card is associated under. A card may only belong to one\nproject column at a time. The column field will be null if the card is created\nin a pending state and has yet to be associated with a column. Once cards are\nassociated with a column, they will not become pending in the future.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ProjectCardItem)

The card content item.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

The actor who created this card.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean!)

Whether the card is archived.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The card note.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project!)

The project that contains this card.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this card.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectCardState)

The state of ProjectCard.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this card.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectCardConnection\n

\n

The connection type for ProjectCard.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ProjectCardEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ProjectCard])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectCardEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ProjectCard)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectColumn\n

\n

A column inside a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cards (ProjectCardConnection!)

List of cards in the column.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The project column's name.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project!)

The project that contains this column.

\n\n\n\n\n\n\n\n\n\n\n\n

purpose (ProjectColumnPurpose)

The semantic purpose of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this project column.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this project column.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectColumnConnection\n

\n

The connection type for ProjectColumn.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ProjectColumnEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ProjectColumn])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectColumnEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ProjectColumn)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectConnection\n

\n

A list of projects associated with the owner.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ProjectEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Project])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Project)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectProgress\n

\n

Project progress stats.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

doneCount (Int!)

The number of done cards.

\n\n\n\n\n\n\n\n\n\n\n\n

donePercentage (Float!)

The percentage of done cards.

\n\n\n\n\n\n\n\n\n\n\n\n

enabled (Boolean!)

Whether progress tracking is enabled and cards with purpose exist for this project.

\n\n\n\n\n\n\n\n\n\n\n\n

inProgressCount (Int!)

The number of in-progress cards.

\n\n\n\n\n\n\n\n\n\n\n\n

inProgressPercentage (Float!)

The percentage of in-progress cards.

\n\n\n\n\n\n\n\n\n\n\n\n

todoCount (Int!)

The number of to do cards.

\n\n\n\n\n\n\n\n\n\n\n\n

todoPercentage (Float!)

The percentage of to do cards.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PublicKey\n

\n

A user's public key.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

accessedAt (DateTime)

The last time this authorization was used to perform an action. Values will be null for keys not owned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime)

Identifies the date and time when the key was created. Keys created before\nMarch 5th, 2014 have inaccurate values. Values will be null for keys not owned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

fingerprint (String!)

The fingerprint for this PublicKey.

\n\n\n\n\n\n\n\n\n\n\n\n

isReadOnly (Boolean)

Whether this PublicKey is read-only or not. Values will be null for keys not owned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The public key string.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime)

Identifies the date and time when the key was updated. Keys created before\nMarch 5th, 2014 may have inaccurate values. Values will be null for keys not\nowned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PublicKeyConnection\n

\n

The connection type for PublicKey.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PublicKeyEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PublicKey])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PublicKeyEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PublicKey)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequest\n

\n

A repository pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

activeLockReason (LockReason)

Reason that the conversation was locked.

\n\n\n\n\n\n\n\n\n\n\n\n

additions (Int!)

The number of additions in this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

assignees (UserConnection!)

A list of Users assigned to this object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

autoMergeRequest (AutoMergeRequest)

Returns the auto-merge request object if one exists for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRef (Ref)

Identifies the base Ref associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String!)

Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefOid (GitObjectID!)

Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRepository (Repository)

The repository associated with this pull request's base Ref.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

canBeRebased (Boolean!)

Whether or not the pull request is rebaseable.

\n\n\n\n\n
\n

Preview notice

\n

canBeRebased is available under the Merge info preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

changedFiles (Int!)

The number of changed files in this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

checksResourcePath (URI!)

The HTTP path for the checks of this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

checksUrl (URI!)

The HTTP URL for the checks of this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

closed (Boolean!)

true if the pull request is closed.

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (IssueCommentConnection!)

A list of comments associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueCommentOrder)

\n

Ordering options for issue comments returned from the connection.

\n\n
\n\n
\n\n\n

commits (PullRequestCommitConnection!)

A list of commits present in this pull request's head branch not present in the base branch.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions (Int!)

The number of deletions in this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited this pull request's body.

\n\n\n\n\n\n\n\n\n\n\n\n

files (PullRequestChangedFileConnection)

Lists the files changed within this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

headRef (Ref)

Identifies the head Ref associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefOid (GitObjectID!)

Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

headRepository (Repository)

The repository associated with this pull request's head Ref.

\n\n\n\n\n\n\n\n\n\n\n\n

headRepositoryOwner (RepositoryOwner)

The owner of the repository associated with this pull request's head Ref.

\n\n\n\n\n\n\n\n\n\n\n\n

hovercard (Hovercard!)

The hovercard information for this issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

includeNotificationContexts (Boolean)

\n

Whether or not to include notification contexts.

\n

The default value is true.

\n
\n\n
\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

The head and base repositories are different.

\n\n\n\n\n\n\n\n\n\n\n\n

isDraft (Boolean!)

Identifies if the pull request is a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

isReadByViewer (Boolean)

Is this pull request read by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

labels (LabelConnection)

A list of labels associated with the object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

latestOpinionatedReviews (PullRequestReviewConnection)

A list of latest reviews per user associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

writersOnly (Boolean)

\n

Only return reviews from user who have write access to the repository.

\n

The default value is false.

\n
\n\n
\n\n\n

latestReviews (PullRequestReviewConnection)

A list of latest reviews per user associated with the pull request that are not also pending review.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

locked (Boolean!)

true if the pull request is locked.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean!)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeCommit (Commit)

The commit that was created when this pull request was merged.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeStateStatus (MergeStateStatus!)

Detailed information about the current pull request merge state status.

\n\n\n\n\n
\n

Preview notice

\n

mergeStateStatus is available under the Merge info preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

mergeable (MergeableState!)

Whether or not the pull request can be merged based on the existence of merge conflicts.

\n\n\n\n\n\n\n\n\n\n\n\n

merged (Boolean!)

Whether or not the pull request was merged.

\n\n\n\n\n\n\n\n\n\n\n\n

mergedAt (DateTime)

The date and time that the pull request was merged.

\n\n\n\n\n\n\n\n\n\n\n\n

mergedBy (Actor)

The actor who merged the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (Milestone)

Identifies the milestone associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the pull request number.

\n\n\n\n\n\n\n\n\n\n\n\n

participants (UserConnection!)

A list of Users that are participating in the Pull Request conversation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

permalink (URI!)

The permalink to the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

potentialMergeCommit (Commit)

The commit that GitHub automatically generated to test if this pull request\ncould be merged. This field will not return a value if the pull request is\nmerged, or if the test merge commit is still being generated. See the\nmergeable field for more details on the mergeability of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCards (ProjectCardConnection!)

List of project cards associated with this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

revertResourcePath (URI!)

The HTTP path for reverting this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

revertUrl (URI!)

The HTTP URL for reverting this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDecision (PullRequestReviewDecision)

The current status of this pull request with respect to code review.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewRequests (ReviewRequestConnection)

A list of review requests associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

reviewThreads (PullRequestReviewThreadConnection!)

The list of all review threads for this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

reviews (PullRequestReviewConnection)

A list of reviews associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

author (String)

\n

Filter by author of the review.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

states ([PullRequestReviewState!])

\n

A list of states to filter the reviews.

\n\n
\n\n
\n\n\n

state (PullRequestState!)

Identifies the state of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

suggestedReviewers ([SuggestedReviewer]!)

A list of reviewer suggestions based on commit history and past review comments.

\n\n\n\n\n\n\n\n\n\n\n\n

timeline (PullRequestTimelineConnection!)

A list of events, comments, commits, etc. associated with the pull request.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

timeline is deprecated.

timeline will be removed Use PullRequest.timelineItems instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Allows filtering timeline events by a since timestamp.

\n\n
\n\n
\n\n\n

timelineItems (PullRequestTimelineItemsConnection!)

A list of events, comments, commits, etc. associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

itemTypes ([PullRequestTimelineItemsItemType!])

\n

Filter timeline items by type.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Filter timeline items by a since timestamp.

\n\n
\n\n
\n

skip (Int)

\n

Skips the first n elements in the list.

\n\n
\n\n
\n\n\n

title (String!)

Identifies the pull request title.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanApplySuggestion (Boolean!)

Whether or not the viewer can apply suggestion.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanDeleteHeadRef (Boolean!)

Check if the viewer can restore the deleted head ref.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanDisableAutoMerge (Boolean!)

Whether or not the viewer can disable auto-merge.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanEnableAutoMerge (Boolean!)

Whether or not the viewer can enable auto-merge.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerMergeBodyText (String!)

The merge body text for the viewer and method.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

mergeType (PullRequestMergeMethod)

\n

The merge method for the message.

\n\n
\n\n
\n\n\n

viewerMergeHeadlineText (String!)

The merge headline text for the viewer and method.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

mergeType (PullRequestMergeMethod)

\n

The merge method for the message.

\n\n
\n\n
\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestChangedFile\n

\n

A file changed in a pull request.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

additions (Int!)

The number of additions to the file.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions (Int!)

The number of deletions to the file.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerViewedState (FileViewedState!)

The state of the file for the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestChangedFileConnection\n

\n

The connection type for PullRequestChangedFile.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestChangedFileEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestChangedFile])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestChangedFileEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestChangedFile)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommit\n

\n

Represents a Git commit part of a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commit (Commit!)

The Git commit object.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request this commit belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this pull request commit.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this pull request commit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommitCommentThread\n

\n

Represents a commit comment thread part of a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (CommitCommentConnection!)

The comments that exist in this thread.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit!)

The commit the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The file the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The position in the diff for the commit that the comment was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request this commit comment thread belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommitConnection\n

\n

The connection type for PullRequestCommit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestCommitEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestCommit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommitEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestCommit)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestConnection\n

\n

The connection type for PullRequest.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequest])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestContributionsByRepository\n

\n

This aggregates pull requests opened by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedPullRequestContributionConnection!)

The pull request contributions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the pull requests were opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequest)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReview\n

\n

A review object for a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorCanPushToRepository (Boolean!)

Indicates whether the author of this review has push access to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the pull request review body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body of this review rendered as plain text.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (PullRequestReviewCommentConnection!)

A list of review comments for the current pull request review.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit)

Identifies the commit associated with this pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

onBehalfOf (TeamConnection!)

A list of teams that this review was made on behalf of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

Identifies the pull request associated with this pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path permalink for this PullRequestReview.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestReviewState!)

Identifies the current state of the pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

submittedAt (DateTime)

Identifies when the Pull Request Review was submitted.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL permalink for this PullRequestReview.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewComment\n

\n

A review comment associated with a given repository pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The comment body of this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The comment body of this review comment rendered as plain text.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies when the comment was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

diffHunk (String!)

The diff hunk to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

draftedAt (DateTime!)

Identifies when the comment was created in a draft state.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

originalCommit (Commit)

Identifies the original commit associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

originalPosition (Int!)

The original line index in the diff to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

outdated (Boolean!)

Identifies when the comment body is outdated.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The line index in the diff to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request associated with this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReview (PullRequestReview)

The pull request review associated with this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

replyTo (PullRequestReviewComment)

The comment this is a reply to.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path permalink for this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestReviewCommentState!)

Identifies the state of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies when the comment was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL permalink for this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewCommentConnection\n

\n

The connection type for PullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestReviewCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestReviewComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestReviewComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewConnection\n

\n

The connection type for PullRequestReview.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestReviewEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestReview])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewContributionsByRepository\n

\n

This aggregates pull request reviews made by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedPullRequestReviewContributionConnection!)

The pull request review contributions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the pull request reviews were made.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestReview)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewThread\n

\n

A threaded list of comments for a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (PullRequestReviewCommentConnection!)

A list of pull request comments associated with the thread.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

skip (Int)

\n

Skips the first n elements in the list.

\n\n
\n\n
\n\n\n

diffSide (DiffSide!)

The side of the diff on which this thread was placed.

\n\n\n\n\n\n\n\n\n\n\n\n

isCollapsed (Boolean!)

Whether or not the thread has been collapsed (outdated or resolved).

\n\n\n\n\n\n\n\n\n\n\n\n

isOutdated (Boolean!)

Indicates whether this thread was outdated by newer changes.

\n\n\n\n\n\n\n\n\n\n\n\n

isResolved (Boolean!)

Whether this thread has been resolved.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int)

The line in the file to which this thread refers.

\n\n\n\n\n\n\n\n\n\n\n\n

originalLine (Int)

The original line in the file to which this thread refers.

\n\n\n\n\n\n\n\n\n\n\n\n

originalStartLine (Int)

The original start line in the file to which this thread refers (multi-line only).

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Identifies the file path of this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

Identifies the pull request associated with this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

Identifies the repository associated with this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

resolvedBy (User)

The user who resolved this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

startDiffSide (DiffSide)

The side of the diff that the first line of the thread starts on (multi-line only).

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The start line in the file to which this thread refers (multi-line only).

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReply (Boolean!)

Indicates whether the current viewer can reply to this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanResolve (Boolean!)

Whether or not the viewer can resolve this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUnresolve (Boolean!)

Whether or not the viewer can unresolve this thread.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewThreadConnection\n

\n

Review comment threads for a pull request review.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestReviewThreadEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestReviewThread])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewThreadEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestReviewThread)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestRevisionMarker\n

\n

Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

lastSeenCommit (Commit!)

The last commit the viewer has seen.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request to which the marker belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineConnection\n

\n

The connection type for PullRequestTimelineItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestTimelineItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestTimelineItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestTimelineItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineItemsConnection\n

\n

The connection type for PullRequestTimelineItems.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestTimelineItemsEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

filteredCount (Int!)

Identifies the count of items after applying before and after filters.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestTimelineItems])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageCount (Int!)

Identifies the count of items after applying before/after filters and first/last/skip slicing.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the timeline was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineItemsEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestTimelineItems)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Push\n

\n

A Git push.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

nextSha (GitObjectID)

The SHA after the push.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI!)

The permalink for this push.

\n\n\n\n\n\n\n\n\n\n\n\n

previousSha (GitObjectID)

The SHA before the push.

\n\n\n\n\n\n\n\n\n\n\n\n

pusher (User!)

The user who pushed.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository that was pushed to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PushAllowance\n

\n

A team, user or app who has the ability to push to a protected branch.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (PushAllowanceActor)

The actor that can push.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule associated with the allowed user or team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PushAllowanceConnection\n

\n

The connection type for PushAllowance.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PushAllowanceEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PushAllowance])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PushAllowanceEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PushAllowance)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RateLimit\n

\n

Represents the client's rate limit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cost (Int!)

The point cost for the current query counting against the rate limit.

\n\n\n\n\n\n\n\n\n\n\n\n

limit (Int!)

The maximum number of points the client is permitted to consume in a 60 minute window.

\n\n\n\n\n\n\n\n\n\n\n\n

nodeCount (Int!)

The maximum number of nodes this query may return.

\n\n\n\n\n\n\n\n\n\n\n\n

remaining (Int!)

The number of points remaining in the current rate limit window.

\n\n\n\n\n\n\n\n\n\n\n\n

resetAt (DateTime!)

The time at which the current rate limit window resets in UTC epoch seconds.

\n\n\n\n\n\n\n\n\n\n\n\n

used (Int!)

The number of points used in the current rate limit window.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactingUserConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReactingUserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactingUserEdge\n

\n

Represents a user that's made a reaction.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

reactedAt (DateTime!)

The moment when the user made the reaction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Reaction\n

\n

An emoji reaction to a particular piece of content.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

content (ReactionContent!)

Identifies the emoji reaction.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

reactable (Reactable!)

The reactable piece of content.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

Identifies the user who created this reaction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactionConnection\n

\n

A list of reactions that have been left on the subject.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReactionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Reaction])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasReacted (Boolean!)

Whether or not the authenticated user has left a reaction on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Reaction)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactionGroup\n

\n

A group of emoji reactions to a particular piece of content.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

content (ReactionContent!)

Identifies the emoji reaction.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime)

Identifies when the reaction was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (Reactable!)

The subject that was reacted to.

\n\n\n\n\n\n\n\n\n\n\n\n

users (ReactingUserConnection!)

Users who have reacted to the reaction subject with the emotion represented by this reaction group.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerHasReacted (Boolean!)

Whether or not the authenticated user has left a reaction on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReadyForReviewEvent\n

\n

Represents aready_for_reviewevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this ready for review event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this ready for review event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Ref\n

\n

Represents a Git reference.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

associatedPullRequests (PullRequestConnection!)

A list of pull requests with this ref as the head ref.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

branchProtectionRule (BranchProtectionRule)

Branch protection rules for this ref.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The ref name.

\n\n\n\n\n\n\n\n\n\n\n\n

prefix (String!)

The ref's prefix, such as refs/heads/ or refs/tags/.

\n\n\n\n\n\n\n\n\n\n\n\n

refUpdateRule (RefUpdateRule)

Branch protection rules that are viewable by non-admins.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository the ref belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

target (GitObject)

The object the ref points to. Returns null when object does not exist.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RefConnection\n

\n

The connection type for Ref.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RefEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Ref])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RefEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Ref)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RefUpdateRule\n

\n

A ref update rules for a viewer.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean!)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean!)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String!)

Identifies the protection rule pattern.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean!)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresSignatures (Boolean!)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanPush (Boolean!)

Can the viewer push to the branch.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReferencedEvent\n

\n

Represents areferencedevent on a given ReferencedSubject.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with thereferencedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

commitRepository (Repository!)

Identifies the repository associated with thereferencedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

isDirectReference (Boolean!)

Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (ReferencedSubject!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Release\n

\n

A release contains the content for a release.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (User)

The author of the release.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the release.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML)

The description of this release rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

isDraft (Boolean!)

Whether or not the release is a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

isLatest (Boolean!)

Whether or not the release is the latest releast.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrerelease (Boolean!)

Whether or not the release is a prerelease.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The title of the release.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies the date and time when the release was created.

\n\n\n\n\n\n\n\n\n\n\n\n

releaseAssets (ReleaseAssetConnection!)

List of releases assets which are dependent on this release.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

name (String)

\n

A list of names to filter the assets by.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository that the release belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

shortDescriptionHTML (HTML)

A description of the release, rendered to HTML without any links in it.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

limit (Int)

\n

How many characters to return.

\n

The default value is 200.

\n
\n\n
\n\n\n

tag (Ref)

The Git tag the release points to.

\n\n\n\n\n\n\n\n\n\n\n\n

tagName (String!)

The name of the release's Git tag.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseAsset\n

\n

A release asset contains the content for a release asset.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contentType (String!)

The asset's content-type.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

downloadCount (Int!)

The number of times this asset was downloaded.

\n\n\n\n\n\n\n\n\n\n\n\n

downloadUrl (URI!)

Identifies the URL where you can download the release asset via the browser.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Identifies the title of the release asset.

\n\n\n\n\n\n\n\n\n\n\n\n

release (Release)

Release that the asset is associated with.

\n\n\n\n\n\n\n\n\n\n\n\n

size (Int!)

The size (in bytes) of the asset.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

uploadedBy (User!)

The user that performed the upload.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

Identifies the URL of the release asset.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseAssetConnection\n

\n

The connection type for ReleaseAsset.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReleaseAssetEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ReleaseAsset])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseAssetEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ReleaseAsset)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseConnection\n

\n

The connection type for Release.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReleaseEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Release])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Release)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RemovedFromProjectEvent\n

\n

Represents aremoved_from_projectevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RenamedTitleEvent\n

\n

Represents arenamedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

currentTitle (String!)

Identifies the current title of the issue or pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

previousTitle (String!)

Identifies the previous title of the issue or pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (RenamedTitleSubject!)

Subject that was renamed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReopenedEvent\n

\n

Represents areopenedevent on any Closable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

closable (Closable!)

Object that was reopened.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoAccessAuditEntry\n

\n

Audit log entry for a repo.access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoAccessAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoAddMemberAuditEntry\n

\n

Audit log entry for a repo.add_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoAddMemberAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoAddTopicAuditEntry\n

\n

Audit log entry for a repo.add_topic event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topic (Topic)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicName (String)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoArchivedAuditEntry\n

\n

Audit log entry for a repo.archived event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoArchivedAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoChangeMergeSettingAuditEntry\n

\n

Audit log entry for a repo.change_merge_setting event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isEnabled (Boolean)

Whether the change was to enable (true) or disable (false) the merge type.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeType (RepoChangeMergeSettingAuditEntryMergeType)

The merge method affected by the change.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.disable_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.disable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableContributorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.disable_contributors_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableSockpuppetDisallowedAuditEntry\n

\n

Audit log entry for a repo.config.disable_sockpuppet_disallowed event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.enable_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.enable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableContributorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.enable_contributors_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableSockpuppetDisallowedAuditEntry\n

\n

Audit log entry for a repo.config.enable_sockpuppet_disallowed event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigLockAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.lock_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigUnlockAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.unlock_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoCreateAuditEntry\n

\n

Audit log entry for a repo.create event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

forkParentName (String)

The name of the parent repository for this forked repository.

\n\n\n\n\n\n\n\n\n\n\n\n

forkSourceName (String)

The name of the root repository for this network.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoCreateAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoDestroyAuditEntry\n

\n

Audit log entry for a repo.destroy event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoDestroyAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoRemoveMemberAuditEntry\n

\n

Audit log entry for a repo.remove_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoRemoveMemberAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoRemoveTopicAuditEntry\n

\n

Audit log entry for a repo.remove_topic event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topic (Topic)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicName (String)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Repository\n

\n

A repository contains the content for a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableUsers (UserConnection!)

A list of users that can be assigned to issues in this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters users with query on user name and login.

\n\n
\n\n
\n\n\n

branchProtectionRules (BranchProtectionRuleConnection!)

A list of branch protection rules for this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

codeOfConduct (CodeOfConduct)

Returns the code of conduct for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

collaborators (RepositoryCollaboratorConnection)

A list of collaborators associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliation (CollaboratorAffiliation)

\n

Collaborators affiliation level with a repository.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters users with query on user name and login.

\n\n
\n\n
\n\n\n

commitComments (CommitCommentConnection!)

A list of commit comments associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

contactLinks ([RepositoryContactLink!])

Returns a list of contact links associated to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

defaultBranchRef (Ref)

The Ref associated with the repository's default branch.

\n\n\n\n\n\n\n\n\n\n\n\n

deleteBranchOnMerge (Boolean!)

Whether or not branches are automatically deleted when merged in this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

dependencyGraphManifests (DependencyGraphManifestConnection)

A list of dependency manifests contained in the repository.

\n\n\n\n\n
\n

Preview notice

\n

dependencyGraphManifests is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

dependenciesAfter (String)

\n

Cursor to paginate dependencies.

\n\n
\n\n
\n

dependenciesFirst (Int)

\n

Number of dependencies to fetch.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

withDependencies (Boolean)

\n

Flag to scope to only manifests with dependencies.

\n\n
\n\n
\n\n\n

deployKeys (DeployKeyConnection!)

A list of deploy keys that are on this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

deployments (DeploymentConnection!)

Deployments associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

environments ([String!])

\n

Environments to list deployments for.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (DeploymentOrder)

\n

Ordering options for deployments returned from the connection.

\n\n
\n\n
\n\n\n

description (String)

The description of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML!)

The description of the repository rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

diskUsage (Int)

The number of kilobytes this repository occupies on disk.

\n\n\n\n\n\n\n\n\n\n\n\n

forkCount (Int!)

Returns how many forks there are of this repository in the whole network.

\n\n\n\n\n\n\n\n\n\n\n\n

forks (RepositoryConnection!)

A list of direct forked repositories.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

fundingLinks ([FundingLink!]!)

The funding links for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean!)

Indicates if the repository has issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasProjectsEnabled (Boolean!)

Indicates if the repository has the Projects feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean!)

Indicates if the repository has wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The repository's URL.

\n\n\n\n\n\n\n\n\n\n\n\n

interactionAbility (RepositoryInteractionAbility)

The interaction ability settings for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean!)

Indicates if the repository is unmaintained.

\n\n\n\n\n\n\n\n\n\n\n\n

isBlankIssuesEnabled (Boolean!)

Returns true if blank issue creation is allowed.

\n\n\n\n\n\n\n\n\n\n\n\n

isDisabled (Boolean!)

Returns whether or not this repository disabled.

\n\n\n\n\n\n\n\n\n\n\n\n

isEmpty (Boolean!)

Returns whether or not this repository is empty.

\n\n\n\n\n\n\n\n\n\n\n\n

isFork (Boolean!)

Identifies if the repository is a fork.

\n\n\n\n\n\n\n\n\n\n\n\n

isInOrganization (Boolean!)

Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.

\n\n\n\n\n\n\n\n\n\n\n\n

isLocked (Boolean!)

Indicates if the repository has been locked or not.

\n\n\n\n\n\n\n\n\n\n\n\n

isMirror (Boolean!)

Identifies if the repository is a mirror.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrivate (Boolean!)

Identifies if the repository is private.

\n\n\n\n\n\n\n\n\n\n\n\n

isSecurityPolicyEnabled (Boolean)

Returns true if this repository has a security policy.

\n\n\n\n\n\n\n\n\n\n\n\n

isTemplate (Boolean!)

Identifies if the repository is a template that can be used to generate new repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

isUserConfigurationRepository (Boolean!)

Is this repository a user configuration repository?.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue)

Returns a single issue from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the issue to be returned.

\n\n
\n\n
\n\n\n

issueOrPullRequest (IssueOrPullRequest)

Returns a single issue-like object from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the issue to be returned.

\n\n
\n\n
\n\n\n

issueTemplates ([IssueTemplate!])

Returns a list of issue templates associated to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

issues (IssueConnection!)

A list of issues that have been opened in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

label (Label)

Returns a single label by name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

Label name.

\n\n
\n\n
\n\n\n

labels (LabelConnection)

A list of labels associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n

query (String)

\n

If provided, searches labels by name and description.

\n\n
\n\n
\n\n\n

languages (LanguageConnection)

A list containing a breakdown of the language composition of the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LanguageOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

latestRelease (Release)

Get the latest release for the repository if one exists.

\n\n\n\n\n\n\n\n\n\n\n\n

licenseInfo (License)

The license associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (RepositoryLockReason)

The reason the repository has been locked.

\n\n\n\n\n\n\n\n\n\n\n\n

mentionableUsers (UserConnection!)

A list of Users that can be mentioned in the context of the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters users with query on user name and login.

\n\n
\n\n
\n\n\n

mergeCommitAllowed (Boolean!)

Whether or not PRs are merged with a merge commit on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (Milestone)

Returns a single milestone from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the milestone to be returned.

\n\n
\n\n
\n\n\n

milestones (MilestoneConnection)

A list of milestones associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (MilestoneOrder)

\n

Ordering options for milestones.

\n\n
\n\n
\n

query (String)

\n

Filters milestones with a query on the title.

\n\n
\n\n
\n

states ([MilestoneState!])

\n

Filter by the state of the milestones.

\n\n
\n\n
\n\n\n

mirrorUrl (URI)

The repository's original mirror URL.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

nameWithOwner (String!)

The repository's name with owner.

\n\n\n\n\n\n\n\n\n\n\n\n

object (GitObject)

A Git object in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

expression (String)

\n

A Git revision expression suitable for rev-parse.

\n\n
\n\n
\n

oid (GitObjectID)

\n

The Git object ID.

\n\n
\n\n
\n\n\n

openGraphImageUrl (URI!)

The image used to represent this repository in Open Graph data.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (RepositoryOwner!)

The User owner of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

packages (PackageConnection!)

A list of packages under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

names ([String])

\n

Find packages by their names.

\n\n
\n\n
\n

orderBy (PackageOrder)

\n

Ordering of the returned packages.

\n\n
\n\n
\n

packageType (PackageType)

\n

Filter registry package by type.

\n\n
\n\n
\n

repositoryId (ID)

\n

Find packages in a repository by ID.

\n\n
\n\n
\n\n\n

parent (Repository)

The repository parent, if this is a fork.

\n\n\n\n\n\n\n\n\n\n\n\n

pinnedIssues (PinnedIssueConnection)

A list of pinned issues for this repository.

\n\n\n\n\n
\n

Preview notice

\n

pinnedIssues is available under the Pinned issues preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

primaryLanguage (Language)

The primary language of the repository's code.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Find project by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The project number to find.

\n\n
\n\n
\n\n\n

projects (ProjectConnection!)

A list of projects under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ProjectOrder)

\n

Ordering options for projects returned from the connection.

\n\n
\n\n
\n

search (String)

\n

Query to search projects by, currently only searching by name.

\n\n
\n\n
\n

states ([ProjectState!])

\n

A list of states to filter the projects by.

\n\n
\n\n
\n\n\n

projectsResourcePath (URI!)

The HTTP path listing the repository's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

projectsUrl (URI!)

The HTTP URL listing the repository's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

Returns a single pull request from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the pull request to be returned.

\n\n
\n\n
\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests that have been opened in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

pushedAt (DateTime)

Identifies when the repository was last pushed to.

\n\n\n\n\n\n\n\n\n\n\n\n

rebaseMergeAllowed (Boolean!)

Whether or not rebase-merging is enabled on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Fetch a given ref from the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

qualifiedName (String!)

\n

The ref to retrieve. Fully qualified matches are checked in order\n(refs/heads/master) before falling back onto checks for short name matches (master).

\n\n
\n\n
\n\n\n

refs (RefConnection)

Fetch a list of refs from the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

direction (OrderDirection)

\n

DEPRECATED: use orderBy. The ordering direction.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RefOrder)

\n

Ordering options for refs returned from the connection.

\n\n
\n\n
\n

query (String)

\n

Filters refs with query on name.

\n\n
\n\n
\n

refPrefix (String!)

\n

A ref name prefix like refs/heads/, refs/tags/, etc.

\n\n
\n\n
\n\n\n

release (Release)

Lookup a single release given various criteria.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

tagName (String!)

\n

The name of the Tag the Release was created from.

\n\n
\n\n
\n\n\n

releases (ReleaseConnection!)

List of releases which are dependent on this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReleaseOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

repositoryTopics (RepositoryTopicConnection!)

A list of applied repository-topic associations for this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

securityPolicyUrl (URI)

The security policy URL.

\n\n\n\n\n\n\n\n\n\n\n\n

shortDescriptionHTML (HTML!)

A description of the repository, rendered to HTML without any links in it.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

limit (Int)

\n

How many characters to return.

\n

The default value is 200.

\n
\n\n
\n\n\n

squashMergeAllowed (Boolean!)

Whether or not squash-merging is enabled on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

sshUrl (GitSSHRemote!)

The SSH URL to clone this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

submodules (SubmoduleConnection!)

Returns a list of all submodules in this repository parsed from the\n.gitmodules file as of the default branch's HEAD commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

tempCloneToken (String)

Temporary authentication token for cloning this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

templateRepository (Repository)

The repository from which this repository was generated, if any.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

usesCustomOpenGraphImage (Boolean!)

Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAdminister (Boolean!)

Indicates whether the viewer has admin permissions on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdateTopics (Boolean!)

Indicates whether the viewer can update the topics of this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDefaultCommitEmail (String)

The last commit email for the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDefaultMergeMethod (PullRequestMergeMethod!)

The last used merge method by the viewer or the default for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerPermission (RepositoryPermission)

The users permission level on the repository. Will return null if authenticated as an GitHub App.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerPossibleCommitEmails ([String!])

A list of emails this viewer can commit with.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerabilityAlerts (RepositoryVulnerabilityAlertConnection)

A list of vulnerability alerts that are on this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

watchers (UserConnection!)

A list of users watching the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryCollaboratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryCollaboratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryCollaboratorEdge\n

\n

Represents a user who is a collaborator of a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (RepositoryPermission!)

The permission the user has on the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

permissionSources ([PermissionSource!])

A list of sources for the user's access to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryConnection\n

\n

A list of repositories owned by the subject.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Repository])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalDiskUsage (Int!)

The total size in kilobytes of all repositories in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryContactLink\n

\n

A repository contact link.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

about (String!)

The contact link purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The contact link name.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The contact link URL.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Repository)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInteractionAbility\n

\n

Repository interaction limit that applies to this object.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

expiresAt (DateTime)

The time the currently active limit expires.

\n\n\n\n\n\n\n\n\n\n\n\n

limit (RepositoryInteractionLimit!)

The current limit that is enabled on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

origin (RepositoryInteractionLimitOrigin!)

The origin of the currently active interaction limit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInvitation\n

\n

An invitation for a user to be added to a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String)

The email address that received the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (User)

The user who received the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

inviter (User!)

The user who created the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI!)

The permalink for this repository invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (RepositoryPermission!)

The permission granted on this repository by this invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (RepositoryInfo)

The Repository the user is invited to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationConnection\n

\n

The connection type for RepositoryInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([RepositoryInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (RepositoryInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryTopic\n

\n

A repository-topic connects a repository to a topic.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

resourcePath (URI!)

The HTTP path for this repository-topic.

\n\n\n\n\n\n\n\n\n\n\n\n

topic (Topic!)

The topic.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this repository-topic.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryTopicConnection\n

\n

The connection type for RepositoryTopic.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryTopicEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([RepositoryTopic])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryTopicEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (RepositoryTopic)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVisibilityChangeDisableAuditEntry\n

\n

Audit log entry for a repository_visibility_change.disable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVisibilityChangeEnableAuditEntry\n

\n

Audit log entry for a repository_visibility_change.enable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVulnerabilityAlert\n

\n

A alert for a repository with an affected vulnerability.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

When was the alert created?.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissReason (String)

The reason the alert was dismissed.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissedAt (DateTime)

When was the alert dismissed?.

\n\n\n\n\n\n\n\n\n\n\n\n

dismisser (User)

The user who dismissed the alert.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The associated repository.

\n\n\n\n\n\n\n\n\n\n\n\n

securityAdvisory (SecurityAdvisory)

The associated security advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

securityVulnerability (SecurityVulnerability)

The associated security vulnerability.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableManifestFilename (String!)

The vulnerable manifest filename.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableManifestPath (String!)

The vulnerable manifest path.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableRequirements (String)

The vulnerable requirements.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVulnerabilityAlertConnection\n

\n

The connection type for RepositoryVulnerabilityAlert.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryVulnerabilityAlertEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([RepositoryVulnerabilityAlert])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVulnerabilityAlertEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (RepositoryVulnerabilityAlert)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RestrictedContribution\n

\n

Represents a private contribution a user made on GitHub.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissalAllowance\n

\n

A team or user who has the ability to dismiss a review on a protected branch.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (ReviewDismissalAllowanceActor)

The actor that can dismiss.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule associated with the allowed user or team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissalAllowanceConnection\n

\n

The connection type for ReviewDismissalAllowance.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReviewDismissalAllowanceEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ReviewDismissalAllowance])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissalAllowanceEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ReviewDismissalAllowance)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissedEvent\n

\n

Represents areview_dismissedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissalMessage (String)

Identifies the optional message associated with thereview_dismissedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissalMessageHTML (String)

Identifies the optional message associated with the event, rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

previousReviewState (PullRequestReviewState!)

Identifies the previous state of the review with thereview_dismissedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestCommit (PullRequestCommit)

Identifies the commit which caused the review to become stale.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this review dismissed event.

\n\n\n\n\n\n\n\n\n\n\n\n

review (PullRequestReview)

Identifies the review associated with thereview_dismissedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this review dismissed event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequest\n

\n

A request for a user to review a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

asCodeOwner (Boolean!)

Whether this request was created for a code owner.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

Identifies the pull request associated with this review request.

\n\n\n\n\n\n\n\n\n\n\n\n

requestedReviewer (RequestedReviewer)

The reviewer that is requested.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestConnection\n

\n

The connection type for ReviewRequest.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReviewRequestEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ReviewRequest])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ReviewRequest)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestRemovedEvent\n

\n

Represents anreview_request_removedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

requestedReviewer (RequestedReviewer)

Identifies the reviewer whose review request was removed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestedEvent\n

\n

Represents anreview_requestedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

requestedReviewer (RequestedReviewer)

Identifies the reviewer whose review was requested.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewStatusHovercardContext\n

\n

A hovercard context with a message describing the current code review state of the pull\nrequest.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDecision (PullRequestReviewDecision)

The current status of the pull request with respect to code review.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SavedReply\n

\n

A Saved Reply is text a user can use to reply quickly.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the saved reply.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The saved reply body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the saved reply.

\n\n\n\n\n\n\n\n\n\n\n\n

user (Actor)

The user that saved this reply.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SavedReplyConnection\n

\n

The connection type for SavedReply.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SavedReplyEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SavedReply])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SavedReplyEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SavedReply)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SearchResultItemConnection\n

\n

A list of results that matched against a search query.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

codeCount (Int!)

The number of pieces of code that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

edges ([SearchResultItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

issueCount (Int!)

The number of issues that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SearchResultItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryCount (Int!)

The number of repositories that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

userCount (Int!)

The number of users that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

wikiCount (Int!)

The number of wiki pages that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SearchResultItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SearchResultItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

textMatches ([TextMatch])

Text matches on the result found.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisory\n

\n

A GitHub Security Advisory.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cvss (CVSS!)

The CVSS associated with this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

cwes (CWEConnection!)

CWEs associated with this Advisory.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String!)

This is a long plaintext description of the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

ghsaId (String!)

The GitHub Security Advisory ID.

\n\n\n\n\n\n\n\n\n\n\n\n

identifiers ([SecurityAdvisoryIdentifier!]!)

A list of identifiers for this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

notificationsPermalink (URI)

The permalink for the advisory's dependabot alerts page.

\n\n\n\n\n\n\n\n\n\n\n\n

origin (String!)

The organization that originated the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI)

The permalink for the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime!)

When the advisory was published.

\n\n\n\n\n\n\n\n\n\n\n\n

references ([SecurityAdvisoryReference!]!)

A list of references for this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

severity (SecurityAdvisorySeverity!)

The severity of the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String!)

A short plaintext summary of the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

When the advisory was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerabilities (SecurityVulnerabilityConnection!)

Vulnerabilities associated with this Advisory.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

ecosystem (SecurityAdvisoryEcosystem)

\n

An ecosystem to filter vulnerabilities by.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SecurityVulnerabilityOrder)

\n

Ordering options for the returned topics.

\n\n
\n\n
\n

package (String)

\n

A package name to filter vulnerabilities by.

\n\n
\n\n
\n

severities ([SecurityAdvisorySeverity!])

\n

A list of severities to filter vulnerabilities by.

\n\n
\n\n
\n\n\n

withdrawnAt (DateTime)

When the advisory was withdrawn, if it has been withdrawn.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryConnection\n

\n

The connection type for SecurityAdvisory.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SecurityAdvisoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SecurityAdvisory])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SecurityAdvisory)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryIdentifier\n

\n

A GitHub Security Advisory Identifier.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

type (String!)

The identifier type, e.g. GHSA, CVE.

\n\n\n\n\n\n\n\n\n\n\n\n

value (String!)

The identifier.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryPackage\n

\n

An individual package.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

ecosystem (SecurityAdvisoryEcosystem!)

The ecosystem the package belongs to, e.g. RUBYGEMS, NPM.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The package name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryPackageVersion\n

\n

An individual package version.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

identifier (String!)

The package name or version.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryReference\n

\n

A GitHub Security Advisory Reference.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

url (URI!)

A publicly accessible reference.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityVulnerability\n

\n

An individual vulnerability within an Advisory.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

advisory (SecurityAdvisory!)

The Advisory associated with this Vulnerability.

\n\n\n\n\n\n\n\n\n\n\n\n

firstPatchedVersion (SecurityAdvisoryPackageVersion)

The first version containing a fix for the vulnerability.

\n\n\n\n\n\n\n\n\n\n\n\n

package (SecurityAdvisoryPackage!)

A description of the vulnerable package.

\n\n\n\n\n\n\n\n\n\n\n\n

severity (SecurityAdvisorySeverity!)

The severity of the vulnerability within this package.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

When the vulnerability was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableVersionRange (String!)

A string that describes the vulnerable package versions.\nThis string follows a basic syntax with a few forms.

\n
    \n
  • = 0.2.0 denotes a single vulnerable version.
    • \n
  • <= 1.0.8 denotes a version range up to and including the specified version
    • \n
  • < 0.1.11 denotes a version range up to, but excluding, the specified version
    • \n
  • >= 4.3.0, < 4.3.5 denotes a version range with a known minimum and maximum version.
    • \n
  • >= 0.0.1 denotes a version range with a known minimum, but no known maximum.
    • \n

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityVulnerabilityConnection\n

\n

The connection type for SecurityVulnerability.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SecurityVulnerabilityEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SecurityVulnerability])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityVulnerabilityEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SecurityVulnerability)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SmimeSignature\n

\n

Represents an S/MIME signature on a Commit or Tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String!)

Email used to sign this object.

\n\n\n\n\n\n\n\n\n\n\n\n

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (String!)

ASCII-armored signature header from object.

\n\n\n\n\n\n\n\n\n\n\n\n

signer (User)

GitHub user corresponding to the email signing this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

\n\n\n\n\n\n\n\n\n\n\n\n

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorableItemConnection\n

\n

The connection type for SponsorableItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SponsorableItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SponsorableItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorableItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SponsorableItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorsGoal\n

\n

A goal associated with a GitHub Sponsors listing, representing a target the sponsored maintainer would like to attain.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String)

A description of the goal from the maintainer.

\n\n\n\n\n\n\n\n\n\n\n\n

kind (SponsorsGoalKind!)

What the objective of this goal is.

\n\n\n\n\n\n\n\n\n\n\n\n

percentComplete (Int!)

The percentage representing how complete this goal is, between 0-100.

\n\n\n\n\n\n\n\n\n\n\n\n

targetValue (Int!)

What the goal amount is. Represents a dollar amount for monthly sponsorship\namount goals. Represents a count of unique sponsors for total sponsors count goals.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

A brief summary of the kind and target value of this goal.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorsListing\n

\n

A GitHub Sponsors listing.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

activeGoal (SponsorsGoal)

The current goal the maintainer is trying to reach with GitHub Sponsors, if any.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

fullDescription (String!)

The full description of the listing.

\n\n\n\n\n\n\n\n\n\n\n\n

fullDescriptionHTML (HTML!)

The full description of the listing rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The listing's full name.

\n\n\n\n\n\n\n\n\n\n\n\n

shortDescription (String!)

The short description of the listing.

\n\n\n\n\n\n\n\n\n\n\n\n

slug (String!)

The short name of the listing.

\n\n\n\n\n\n\n\n\n\n\n\n

tiers (SponsorsTierConnection)

The published tiers for this GitHub Sponsors listing.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorsTierOrder)

\n

Ordering options for Sponsors tiers returned from the connection.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorsTier\n

\n

A GitHub Sponsors tier associated with a GitHub Sponsors listing.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

adminInfo (SponsorsTierAdminInfo)

SponsorsTier information only visible to users that can administer the associated Sponsors listing.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String!)

The description of the tier.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML!)

The tier description rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

monthlyPriceInCents (Int!)

How much this tier costs per month in cents.

\n\n\n\n\n\n\n\n\n\n\n\n

monthlyPriceInDollars (Int!)

How much this tier costs per month in dollars.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the tier.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorsListing (SponsorsListing!)

The sponsors listing that this tier belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorsTierAdminInfo\n

\n

SponsorsTier information only visible to users that can administer the associated Sponsors listing.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

sponsorships (SponsorshipConnection!)

The sponsorships associated with this tier.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includePrivate (Boolean)

\n

Whether or not to include private sponsorships in the result set.

\n

The default value is false.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorsTierConnection\n

\n

The connection type for SponsorsTier.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SponsorsTierEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SponsorsTier])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorsTierEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SponsorsTier)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Sponsorship\n

\n

A sponsorship relationship between a sponsor and a maintainer.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainer (User!)

The entity that is being sponsored.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

maintainer is deprecated.

Sponsorship.maintainer will be removed. Use Sponsorship.sponsorable instead. Removal on 2020-04-01 UTC.

\n
\n\n\n\n\n\n\n

privacyLevel (SponsorshipPrivacy!)

The privacy level for this sponsorship.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsor (User)

The user that is sponsoring. Returns null if the sponsorship is private or if sponsor is not a user.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

sponsor is deprecated.

Sponsorship.sponsor will be removed. Use Sponsorship.sponsorEntity instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n\n

sponsorEntity (Sponsor)

The user or organization that is sponsoring, if you have permission to view them.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorable (Sponsorable!)

The entity that is being sponsored.

\n\n\n\n\n\n\n\n\n\n\n\n

tier (SponsorsTier)

The associated sponsorship tier.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorshipConnection\n

\n

The connection type for Sponsorship.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SponsorshipEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Sponsorship])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorshipEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Sponsorship)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StargazerConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([StargazerEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StargazerEdge\n

\n

Represents a user that's starred a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

starredAt (DateTime!)

Identifies when the item was starred.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StarredRepositoryConnection\n

\n

The connection type for Repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([StarredRepositoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

isOverLimit (Boolean!)

Is the list of stars for this user truncated? This is true for users that have many stars.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Repository])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StarredRepositoryEdge\n

\n

Represents a starred repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

starredAt (DateTime!)

Identifies when the item was starred.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Status\n

\n

Represents a commit status.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

combinedContexts (StatusCheckRollupContextConnection!)

A list of status contexts and check runs for this commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit)

The commit this status is attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

context (StatusContext)

Looks up an individual status context by context name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

The context name.

\n\n
\n\n
\n\n\n

contexts ([StatusContext!]!)

The individual status contexts for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (StatusState!)

The combined commit status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusCheckRollup\n

\n

Represents the rollup for both the check runs and status for a commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commit (Commit)

The commit the status and check runs are attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

contexts (StatusCheckRollupContextConnection!)

A list of status contexts and check runs for this commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

state (StatusState!)

The combined status for the commit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusCheckRollupContextConnection\n

\n

The connection type for StatusCheckRollupContext.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([StatusCheckRollupContextEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([StatusCheckRollupContext])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusCheckRollupContextEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (StatusCheckRollupContext)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusContext\n

\n

Represents an individual commit status context.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI)

The avatar of the OAuth application or the user that created the status.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n

The default value is 40.

\n
\n\n
\n\n\n

commit (Commit)

This commit this status context is attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

context (String!)

The name of this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

The actor who created this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description for this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

state (StatusState!)

The state of this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

targetUrl (URI)

The URL for this status context.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Submodule\n

\n

A pointer to a repository at a specific revision embedded inside another repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branch (String)

The branch of the upstream submodule for tracking updates.

\n\n\n\n\n\n\n\n\n\n\n\n

gitUrl (URI!)

The git URL of the submodule repository.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the submodule in .gitmodules.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path in the superproject that this submodule is located in.

\n\n\n\n\n\n\n\n\n\n\n\n

subprojectCommitOid (GitObjectID)

The commit revision of the subproject repository being tracked by the submodule.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SubmoduleConnection\n

\n

The connection type for Submodule.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SubmoduleEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Submodule])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SubmoduleEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Submodule)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SubscribedEvent\n

\n

Represents asubscribedevent on a given Subscribable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribable (Subscribable!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SuggestedReviewer\n

\n

A suggestion to review a pull request based on a user's commit history and review comments.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isAuthor (Boolean!)

Is this suggestion based on past commits?.

\n\n\n\n\n\n\n\n\n\n\n\n

isCommenter (Boolean!)

Is this suggestion based on past review comments?.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewer (User!)

Identifies the user suggested to review the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Tag\n

\n

Represents a Git tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

The Git tag message.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The Git tag name.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the Git object belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

tagger (GitActor)

Details about the tag author.

\n\n\n\n\n\n\n\n\n\n\n\n

target (GitObject!)

The Git object the tag points to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Team\n

\n

A team of users in an organization.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

ancestors (TeamConnection!)

A list of teams that are ancestors of this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

avatarUrl (URI)

A URL pointing to the team's avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size in pixels of the resulting square image.

\n

The default value is 400.

\n
\n\n
\n\n\n

childTeams (TeamConnection!)

List of child teams belonging to this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

immediateOnly (Boolean)

\n

Whether to list immediate child teams or all descendant child teams.

\n

The default value is true.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamOrder)

\n

Order for connection.

\n\n
\n\n
\n

userLogins ([String!])

\n

User logins to filter by.

\n\n
\n\n
\n\n\n

combinedSlug (String!)

The slug corresponding to the organization and team.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

discussion (TeamDiscussion)

Find a team discussion by its number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The sequence number of the discussion to find.

\n\n
\n\n
\n\n\n

discussions (TeamDiscussionConnection!)

A list of team discussions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isPinned (Boolean)

\n

If provided, filters discussions according to whether or not they are pinned.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamDiscussionOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

discussionsResourcePath (URI!)

The HTTP path for team discussions.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionsUrl (URI!)

The HTTP URL for team discussions.

\n\n\n\n\n\n\n\n\n\n\n\n

editTeamResourcePath (URI!)

The HTTP path for editing this team.

\n\n\n\n\n\n\n\n\n\n\n\n

editTeamUrl (URI!)

The HTTP URL for editing this team.

\n\n\n\n\n\n\n\n\n\n\n\n

invitations (OrganizationInvitationConnection)

A list of pending invitations for users to this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

memberStatuses (UserStatusConnection!)

Get the status messages members of this entity have set that are either public or visible only to the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (UserStatusOrder)

\n

Ordering options for user statuses returned from the connection.

\n\n
\n\n
\n\n\n

members (TeamMemberConnection!)

A list of users who are members of this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

membership (TeamMembershipType)

\n

Filter by membership type.

\n

The default value is ALL.

\n
\n\n
\n

orderBy (TeamMemberOrder)

\n

Order for the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (TeamMemberRole)

\n

Filter by team member role.

\n\n
\n\n
\n\n\n

membersResourcePath (URI!)

The HTTP path for the team' members.

\n\n\n\n\n\n\n\n\n\n\n\n

membersUrl (URI!)

The HTTP URL for the team' members.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamResourcePath (URI!)

The HTTP path creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamUrl (URI!)

The HTTP URL creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization!)

The organization that owns this team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeam (Team)

The parent team of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

privacy (TeamPrivacy!)

The level of privacy the team has.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (TeamRepositoryConnection!)

A list of repositories this team has access to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamRepositoryOrder)

\n

Order for the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

repositoriesResourcePath (URI!)

The HTTP path for this team's repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoriesUrl (URI!)

The HTTP URL for this team's repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewRequestDelegationAlgorithm (TeamReviewAssignmentAlgorithm)

What algorithm is used for review assignment for this team.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationAlgorithm is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

reviewRequestDelegationEnabled (Boolean!)

True if review assignment is enabled for this team.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationEnabled is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

reviewRequestDelegationMemberCount (Int)

How many team members are required for review assignment for this team.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationMemberCount is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

reviewRequestDelegationNotifyTeam (Boolean!)

When assigning team members via delegation, whether the entire team should be notified as well.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationNotifyTeam is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

slug (String!)

The slug corresponding to the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsResourcePath (URI!)

The HTTP path for this team's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsUrl (URI!)

The HTTP URL for this team's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAdminister (Boolean!)

Team is adminable by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamAddMemberAuditEntry\n

\n

Audit log entry for a team.add_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamAddRepositoryAuditEntry\n

\n

Audit log entry for a team.add_repository event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamChangeParentTeamAuditEntry\n

\n

Audit log entry for a team.change_parent_team event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeam (Team)

The new parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamName (String)

The name of the new parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamNameWas (String)

The name of the former parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamResourcePath (URI)

The HTTP path for the parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamUrl (URI)

The HTTP URL for the parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamWas (Team)

The former parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamWasResourcePath (URI)

The HTTP path for the previous parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamWasUrl (URI)

The HTTP URL for the previous parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamConnection\n

\n

The connection type for Team.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Team])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussion\n

\n

A team discussion.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the discussion's team.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String!)

Identifies the discussion body hash.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (TeamDiscussionCommentConnection!)

A list of comments on this discussion.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

fromComment (Int)

\n

When provided, filters the connection such that results begin with the comment with this number.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamDiscussionCommentOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

commentsResourcePath (URI!)

The HTTP path for discussion comments.

\n\n\n\n\n\n\n\n\n\n\n\n

commentsUrl (URI!)

The HTTP URL for discussion comments.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isPinned (Boolean!)

Whether or not the discussion is pinned.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrivate (Boolean!)

Whether or not the discussion is only visible to team members and org admins.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the discussion within its team.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team!)

The team that defines the context of this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanPin (Boolean!)

Whether or not the current viewer can pin this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionComment\n

\n

A comment on a team discussion.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the comment's team.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String!)

The current version of the body content.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

discussion (TeamDiscussion!)

The discussion this comment is about.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the comment number.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentConnection\n

\n

The connection type for TeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamDiscussionCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([TeamDiscussionComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (TeamDiscussionComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionConnection\n

\n

The connection type for TeamDiscussion.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamDiscussionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([TeamDiscussion])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (TeamDiscussion)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Team)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamMemberConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamMemberEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamMemberEdge\n

\n

Represents a user who is a member of a team.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

memberAccessResourcePath (URI!)

The HTTP path to the organization's member access page.

\n\n\n\n\n\n\n\n\n\n\n\n

memberAccessUrl (URI!)

The HTTP URL to the organization's member access page.

\n\n\n\n\n\n\n\n\n\n\n\n

role (TeamMemberRole!)

The role the member has on the team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRemoveMemberAuditEntry\n

\n

Audit log entry for a team.remove_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRemoveRepositoryAuditEntry\n

\n

Audit log entry for a team.remove_repository event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRepositoryConnection\n

\n

The connection type for Repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamRepositoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Repository])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRepositoryEdge\n

\n

Represents a team repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (RepositoryPermission!)

The permission level the team has on the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TextMatch\n

\n

A text match within a search result.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

fragment (String!)

The specific text fragment within the property matched on.

\n\n\n\n\n\n\n\n\n\n\n\n

highlights ([TextMatchHighlight!]!)

Highlights within the matched fragment.

\n\n\n\n\n\n\n\n\n\n\n\n

property (String!)

The property matched on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TextMatchHighlight\n

\n

Represents a single highlight in a search result match.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

beginIndice (Int!)

The indice in the fragment where the matched text begins.

\n\n\n\n\n\n\n\n\n\n\n\n

endIndice (Int!)

The indice in the fragment where the matched text ends.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String!)

The text matched.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Topic\n

\n

A topic aggregates entities that are related to a subject.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

name (String!)

The topic's name.

\n\n\n\n\n\n\n\n\n\n\n\n

relatedTopics ([Topic!]!)

A list of related topics, including aliases of this topic, sorted with the most relevant\nfirst. Returns up to 10 Topics.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

first (Int)

\n

How many topics to return.

\n

The default value is 3.

\n
\n\n
\n\n\n

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TransferredEvent\n

\n

Represents atransferredevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

fromRepository (Repository)

The repository this came from.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Tree\n

\n

Represents a Git tree.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

entries ([TreeEntry!])

A list of tree entries.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the Git object belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TreeEntry\n

\n

Represents a Git tree entry.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

extension (String)

The extension of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

isGenerated (Boolean!)

Whether or not this tree entry is generated.

\n\n\n\n\n\n\n\n\n\n\n\n

mode (Int!)

Entry file mode.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Entry file name.

\n\n\n\n\n\n\n\n\n\n\n\n

object (GitObject)

Entry file object.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

Entry file Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The full path of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the tree entry belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

submodule (Submodule)

If the TreeEntry is for a directory occupied by a submodule project, this returns the corresponding submodule.

\n\n\n\n\n\n\n\n\n\n\n\n

type (String!)

Entry file type.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnassignedEvent\n

\n

Represents anunassignedevent on any assignable object.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignable (Assignable!)

Identifies the assignable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignee (Assignee)

Identifies the user or mannequin that was unassigned.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

Identifies the subject (user) who was unassigned.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

user is deprecated.

Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnknownSignature\n

\n

Represents an unknown signature on a Commit or Tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String!)

Email used to sign this object.

\n\n\n\n\n\n\n\n\n\n\n\n

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (String!)

ASCII-armored signature header from object.

\n\n\n\n\n\n\n\n\n\n\n\n

signer (User)

GitHub user corresponding to the email signing this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

\n\n\n\n\n\n\n\n\n\n\n\n

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnlabeledEvent\n

\n

Represents anunlabeledevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

label (Label!)

Identifies the label associated with theunlabeledevent.

\n\n\n\n\n\n\n\n\n\n\n\n

labelable (Labelable!)

Identifies the Labelable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnlockedEvent\n

\n

Represents anunlockedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

lockable (Lockable!)

Object that was unlocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnmarkedAsDuplicateEvent\n

\n

Represents anunmarked_as_duplicateevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

canonical (IssueOrPullRequest)

The authoritative issue or pull request which has been duplicated by another.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicate (IssueOrPullRequest)

The issue or pull request which has been marked as a duplicate of another.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Canonical and duplicate belong to different repositories.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnpinnedEvent\n

\n

Represents anunpinnedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnsubscribedEvent\n

\n

Represents anunsubscribedevent on a given Subscribable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribable (Subscribable!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n User\n

\n

A user is an individual's account on GitHub that owns repositories and can make new content.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

anyPinnableItems (Boolean!)

Determine if this repository owner has any items that can be pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

type (PinnableItemType)

\n

Filter to only a particular kind of pinnable item.

\n\n
\n\n
\n\n\n

avatarUrl (URI!)

A URL pointing to the user's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

bio (String)

The user's public profile bio.

\n\n\n\n\n\n\n\n\n\n\n\n

bioHTML (HTML!)

The user's public profile bio as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

commitComments (CommitCommentConnection!)

A list of commit comments made by this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

company (String)

The user's public profile company.

\n\n\n\n\n\n\n\n\n\n\n\n

companyHTML (HTML!)

The user's public profile company as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionsCollection (ContributionsCollection!)

The collection of contributions this user has made to different repositories.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

from (DateTime)

\n

Only contributions made at this time or later will be counted. If omitted, defaults to a year ago.

\n\n
\n\n
\n

organizationID (ID)

\n

The ID of the organization used to filter contributions.

\n\n
\n\n
\n

to (DateTime)

\n

Only contributions made before and up to and including this time will be\ncounted. If omitted, defaults to the current time.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String!)

The user's publicly visible profile email.

\n\n\n\n\n\n\n\n\n\n\n\n

followers (FollowerConnection!)

A list of users the given user is followed by.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

following (FollowingConnection!)

A list of users the given user is following.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

gist (Gist)

Find gist by repo name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

The gist name to find.

\n\n
\n\n
\n\n\n

gistComments (GistCommentConnection!)

A list of gist comments made by this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

gists (GistConnection!)

A list of the Gists the user has created.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (GistOrder)

\n

Ordering options for gists returned from the connection.

\n\n
\n\n
\n

privacy (GistPrivacy)

\n

Filters Gists according to privacy.

\n\n
\n\n
\n\n\n

hasSponsorsListing (Boolean!)

True if this user/organization has a GitHub Sponsors listing.

\n\n\n\n\n\n\n\n\n\n\n\n

hovercard (Hovercard!)

The hovercard information for this user in a given context.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

primarySubjectId (ID)

\n

The ID of the subject to get the hovercard in the context of.

\n\n
\n\n
\n\n\n

interactionAbility (RepositoryInteractionAbility)

The interaction ability settings for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

isBountyHunter (Boolean!)

Whether or not this user is a participant in the GitHub Security Bug Bounty.

\n\n\n\n\n\n\n\n\n\n\n\n

isCampusExpert (Boolean!)

Whether or not this user is a participant in the GitHub Campus Experts Program.

\n\n\n\n\n\n\n\n\n\n\n\n

isDeveloperProgramMember (Boolean!)

Whether or not this user is a GitHub Developer Program member.

\n\n\n\n\n\n\n\n\n\n\n\n

isEmployee (Boolean!)

Whether or not this user is a GitHub employee.

\n\n\n\n\n\n\n\n\n\n\n\n

isHireable (Boolean!)

Whether or not the user has marked themselves as for hire.

\n\n\n\n\n\n\n\n\n\n\n\n

isSiteAdmin (Boolean!)

Whether or not this user is a site administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

isSponsoredBy (Boolean!)

Check if the given account is sponsoring this user/organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

accountLogin (String!)

\n

The target account's login.

\n\n
\n\n
\n\n\n

isSponsoringViewer (Boolean!)

True if the viewer is sponsored by this user/organization.

\n\n\n\n\n\n\n\n\n\n\n\n

isViewer (Boolean!)

Whether or not this user is the viewing user.

\n\n\n\n\n\n\n\n\n\n\n\n

issueComments (IssueCommentConnection!)

A list of issue comments made by this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueCommentOrder)

\n

Ordering options for issue comments returned from the connection.

\n\n
\n\n
\n\n\n

issues (IssueConnection!)

A list of issues associated with this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

itemShowcase (ProfileItemShowcase!)

Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The user's public profile location.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The username used to login.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The user's public profile name.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

Find an organization by its login that the user belongs to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

login (String!)

\n

The login of the organization to find.

\n\n
\n\n
\n\n\n

organizationVerifiedDomainEmails ([String!]!)

Verified email addresses that match verified domains for a specified organization the user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

login (String!)

\n

The login of the organization to match verified domains from.

\n\n
\n\n
\n\n\n

organizations (OrganizationConnection!)

A list of organizations the user belongs to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

packages (PackageConnection!)

A list of packages under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

names ([String])

\n

Find packages by their names.

\n\n
\n\n
\n

orderBy (PackageOrder)

\n

Ordering of the returned packages.

\n\n
\n\n
\n

packageType (PackageType)

\n

Filter registry package by type.

\n\n
\n\n
\n

repositoryId (ID)

\n

Find packages in a repository by ID.

\n\n
\n\n
\n\n\n

pinnableItems (PinnableItemConnection!)

A list of repositories and gists this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinnable items that are returned.

\n\n
\n\n
\n\n\n

pinnedItems (PinnableItemConnection!)

A list of repositories and gists this profile owner has pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinned items that are returned.

\n\n
\n\n
\n\n\n

pinnedItemsRemaining (Int!)

Returns how many more items this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Find project by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The project number to find.

\n\n
\n\n
\n\n\n

projects (ProjectConnection!)

A list of projects under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ProjectOrder)

\n

Ordering options for projects returned from the connection.

\n\n
\n\n
\n

search (String)

\n

Query to search projects by, currently only searching by name.

\n\n
\n\n
\n

states ([ProjectState!])

\n

A list of states to filter the projects by.

\n\n
\n\n
\n\n\n

projectsResourcePath (URI!)

The HTTP path listing user's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

projectsUrl (URI!)

The HTTP URL listing user's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

publicKeys (PublicKeyConnection!)

A list of public keys associated with this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests associated with this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

repositories (RepositoryConnection!)

A list of repositories that the user owns.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isFork (Boolean)

\n

If non-null, filters repositories according to whether they are forks of another repository.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

repositoriesContributedTo (RepositoryConnection!)

A list of repositories that the user recently contributed to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

contributionTypes ([RepositoryContributionType])

\n

If non-null, include only the specified types of contributions. The\nGitHub.com UI uses [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY].

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includeUserRepositories (Boolean)

\n

If true, include user repositories.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

repository (Repository)

Find Repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

Name of Repository to find.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

savedReplies (SavedReplyConnection)

Replies this user has saved.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SavedReplyOrder)

\n

The field to order saved replies by.

\n\n
\n\n
\n\n\n

sponsorsListing (SponsorsListing)

The GitHub Sponsors listing for this user or organization.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorshipForViewerAsSponsor (Sponsorship)

The viewer's sponsorship of this entity.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorshipsAsMaintainer (SponsorshipConnection!)

This object's sponsorships as the maintainer.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includePrivate (Boolean)

\n

Whether or not to include private sponsorships in the result set.

\n

The default value is false.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

sponsorshipsAsSponsor (SponsorshipConnection!)

This object's sponsorships as the sponsor.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

starredRepositories (StarredRepositoryConnection!)

Repositories the user has starred.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n

ownedByViewer (Boolean)

\n

Filters starred repositories to only return repositories owned by the viewer.

\n\n
\n\n
\n\n\n

status (UserStatus)

The user's description of what they're currently doing.

\n\n\n\n\n\n\n\n\n\n\n\n

topRepositories (RepositoryConnection!)

Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder!)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

since (DateTime)

\n

How far back in time to fetch contributed repositories.

\n\n
\n\n
\n\n\n

twitterUsername (String)

The user's Twitter username.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanChangePinnedItems (Boolean!)

Can the viewer pin repositories and gists to the profile?.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanFollow (Boolean!)

Whether or not the viewer is able to follow the user.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSponsor (Boolean!)

Whether or not the viewer is able to sponsor this user/organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerIsFollowing (Boolean!)

Whether or not this user is followed by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerIsSponsoring (Boolean!)

True if the viewer is sponsoring this user/organization.

\n\n\n\n\n\n\n\n\n\n\n\n

watching (RepositoryConnection!)

A list of repositories the given user is watching.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Affiliation options for repositories returned from the connection. If none\nspecified, the results will include repositories for which the current\nviewer is an owner or collaborator, or member.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

websiteUrl (URI)

A URL pointing to the user's public website/blog.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserBlockedEvent\n

\n

Represents auser_blockedevent on a given user.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

blockDuration (UserBlockDuration!)

Number of days that the user was blocked for.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (User)

The user who was blocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserContentEdit\n

\n

An edit on user content.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

deletedAt (DateTime)

Identifies the date and time when the object was deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

deletedBy (Actor)

The actor who deleted this content.

\n\n\n\n\n\n\n\n\n\n\n\n

diff (String)

A summary of the changes for this edit.

\n\n\n\n\n\n\n\n\n\n\n\n

editedAt (DateTime!)

When this content was edited.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited this content.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserContentEditConnection\n

\n

A list of edits to content.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserContentEditEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([UserContentEdit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserContentEditEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (UserContentEdit)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserEdge\n

\n

Represents a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserEmailMetadata\n

\n

Email attributes from External Identity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

primary (Boolean)

Boolean to identify primary emails.

\n\n\n\n\n\n\n\n\n\n\n\n

type (String)

Type of email.

\n\n\n\n\n\n\n\n\n\n\n\n

value (String!)

Email id.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserStatus\n

\n

The user's description of what they're currently doing.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

emoji (String)

An emoji summarizing the user's status.

\n\n\n\n\n\n\n\n\n\n\n\n

emojiHTML (HTML)

The status emoji as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

expiresAt (DateTime)

If set, the status will not be shown after this date.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

ID of the object.

\n\n\n\n\n\n\n\n\n\n\n\n

indicatesLimitedAvailability (Boolean!)

Whether this status indicates the user is not fully available on GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

A brief message describing what the user is doing.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The organization whose members can see this status. If null, this status is publicly visible.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who has this status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserStatusConnection\n

\n

The connection type for UserStatus.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserStatusEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([UserStatus])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserStatusEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (UserStatus)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n VerifiableDomain\n

\n

A domain that can be verified for an organization or an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

dnsHostName (URI)

The DNS host name that should be used for verification.

\n\n\n\n\n\n\n\n\n\n\n\n

domain (URI!)

The unicode encoded domain.

\n\n\n\n\n\n\n\n\n\n\n\n

hasFoundHostName (Boolean!)

Whether a TXT record for verification with the expected host name was found.

\n\n\n\n\n\n\n\n\n\n\n\n

hasFoundVerificationToken (Boolean!)

Whether a TXT record for verification with the expected verification token was found.

\n\n\n\n\n\n\n\n\n\n\n\n

isRequiredForPolicyEnforcement (Boolean!)

Whether this domain is required to exist for an organization or enterprise policy to be enforced.

\n\n\n\n\n\n\n\n\n\n\n\n

isVerified (Boolean!)

Whether or not the domain is verified.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (VerifiableDomainOwner!)

The owner of the domain.

\n\n\n\n\n\n\n\n\n\n\n\n

punycodeEncodedDomain (URI!)

The punycode encoded domain.

\n\n\n\n\n\n\n\n\n\n\n\n

tokenExpirationTime (DateTime)

The time that the current verification token will expire.

\n\n\n\n\n\n\n\n\n\n\n\n

verificationToken (String)

The current verification token for the domain.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n VerifiableDomainConnection\n

\n

The connection type for VerifiableDomain.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([VerifiableDomainEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([VerifiableDomain])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n VerifiableDomainEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (VerifiableDomain)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ViewerHovercardContext\n

\n

A hovercard context with a message describing how the viewer is related.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

viewer (User!)

Identifies the user who is related to this context.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n", + "html": "
\n
\n

\n ActorLocation\n

\n

Location information for an actor.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

city (String)

City.

\n\n\n\n\n\n\n\n\n\n\n\n

country (String)

Country name.

\n\n\n\n\n\n\n\n\n\n\n\n

countryCode (String)

Country code.

\n\n\n\n\n\n\n\n\n\n\n\n

region (String)

Region name.

\n\n\n\n\n\n\n\n\n\n\n\n

regionCode (String)

Region or state code.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AddedToProjectEvent\n

\n

Represents aadded_to_projectevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectCard (ProjectCard)

Project card referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n App\n

\n

A GitHub App.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the app.

\n\n\n\n\n\n\n\n\n\n\n\n

logoBackgroundColor (String!)

The hex color code, without the leading '#', for the logo background.

\n\n\n\n\n\n\n\n\n\n\n\n

logoUrl (URI!)

A URL pointing to the app's logo.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting image.

\n\n
\n\n
\n\n\n

name (String!)

The name of the app.

\n\n\n\n\n\n\n\n\n\n\n\n

slug (String!)

A slug based on the name of the app for use in URLs.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The URL to the app's homepage.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AssignedEvent\n

\n

Represents anassignedevent on any assignable object.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignable (Assignable!)

Identifies the assignable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignee (Assignee)

Identifies the user or mannequin that was assigned.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

Identifies the user who was assigned.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

user is deprecated.

Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoMergeDisabledEvent\n

\n

Represents aauto_merge_disabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

disabler (User)

The user who disabled auto-merge for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (String)

The reason auto-merge was disabled.

\n\n\n\n\n\n\n\n\n\n\n\n

reasonCode (String)

The reason_code relating to why auto-merge was disabled.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoMergeEnabledEvent\n

\n

Represents aauto_merge_enabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enabler (User)

The user who enabled auto-merge for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoMergeRequest\n

\n

Represents an auto-merge request for a pull request.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address of the author of this auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

The commit message of the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

The commit title of the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

enabledAt (DateTime)

When was this auto-merge request was enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

enabledBy (Actor)

The actor who created the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod!)

The merge method of the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request that this auto-merge request is set against.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoRebaseEnabledEvent\n

\n

Represents aauto_rebase_enabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enabler (User)

The user who enabled auto-merge (rebase) for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoSquashEnabledEvent\n

\n

Represents aauto_squash_enabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enabler (User)

The user who enabled auto-merge (squash) for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutomaticBaseChangeFailedEvent\n

\n

Represents aautomatic_base_change_failedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

newBase (String!)

The new base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

oldBase (String!)

The old base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutomaticBaseChangeSucceededEvent\n

\n

Represents aautomatic_base_change_succeededevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

newBase (String!)

The new base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

oldBase (String!)

The old base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BaseRefChangedEvent\n

\n

Represents abase_ref_changedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

currentRefName (String!)

Identifies the name of the base ref for the pull request after it was changed.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

previousRefName (String!)

Identifies the name of the base ref for the pull request before it was changed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BaseRefDeletedEvent\n

\n

Represents abase_ref_deletedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String)

Identifies the name of the Ref associated with the base_ref_deleted event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BaseRefForcePushedEvent\n

\n

Represents abase_ref_force_pushedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

afterCommit (Commit)

Identifies the after commit SHA for thebase_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeCommit (Commit)

Identifies the before commit SHA for thebase_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the fully qualified ref name for thebase_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Blame\n

\n

Represents a Git blame.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

ranges ([BlameRange!]!)

The list of ranges from a Git blame.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BlameRange\n

\n

Represents a range of information from a Git blame.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

age (Int!)

Identifies the recency of the change, from 1 (new) to 10 (old). This is\ncalculated as a 2-quantile and determines the length of distance between the\nmedian age of all the changes in the file and the recency of the current\nrange's change.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit!)

Identifies the line author.

\n\n\n\n\n\n\n\n\n\n\n\n

endingLine (Int!)

The ending line for the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startingLine (Int!)

The starting line for the range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Blob\n

\n

Represents a Git blob.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

byteSize (Int!)

Byte size of Blob object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

isBinary (Boolean)

Indicates whether the Blob is binary or text. Returns null if unable to determine the encoding.

\n\n\n\n\n\n\n\n\n\n\n\n

isTruncated (Boolean!)

Indicates whether the contents is truncated.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the Git object belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

UTF8 text data or null if the Blob is binary.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Bot\n

\n

A special type of user which takes actions on behalf of GitHub Apps.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the GitHub App's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The username of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this bot.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this bot.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRule\n

\n

A branch protection rule.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean!)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean!)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRuleConflicts (BranchProtectionRuleConflictConnection!)

A list of conflicts matching branches protection rule and other branch protection rules.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

creator (Actor)

The actor who created this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean!)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean!)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

matchingRefs (RefConnection!)

Repository refs that are protected by this rule.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters refs with query on name.

\n\n
\n\n
\n\n\n

pattern (String!)

Identifies the protection rule pattern.

\n\n\n\n\n\n\n\n\n\n\n\n

pushAllowances (PushAllowanceConnection!)

A list push allowances for this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

repository (Repository)

The repository associated with this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean!)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean!)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean!)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean!)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean!)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean!)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean!)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean!)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalAllowances (ReviewDismissalAllowanceConnection!)

A list review dismissal allowances for this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConflict\n

\n

A conflict between two branch protection rules.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

conflictingBranchProtectionRule (BranchProtectionRule)

Identifies the conflicting branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the branch ref that has conflicting rules.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConflictConnection\n

\n

The connection type for BranchProtectionRuleConflict.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([BranchProtectionRuleConflictEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([BranchProtectionRuleConflict])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConflictEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (BranchProtectionRuleConflict)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConnection\n

\n

The connection type for BranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([BranchProtectionRuleEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([BranchProtectionRule])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (BranchProtectionRule)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CVSS\n

\n

The Common Vulnerability Scoring System.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

score (Float!)

The CVSS score associated with this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

vectorString (String)

The CVSS vector string associated with this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CWE\n

\n

A common weakness enumeration.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cweId (String!)

The id of the CWE.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String!)

A detailed description of this CWE.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

ID of the object.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of this CWE.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CWEConnection\n

\n

The connection type for CWE.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CWEEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CWE])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CWEEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CWE)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotation\n

\n

A single check annotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotationLevel (CheckAnnotationLevel)

The annotation's severity level.

\n\n\n\n\n\n\n\n\n\n\n\n

blobUrl (URI!)

The path to the file that this annotation was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

location (CheckAnnotationSpan!)

The position of this annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

The annotation's message.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path that this annotation was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

rawDetails (String)

Additional information about the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The annotation's title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationConnection\n

\n

The connection type for CheckAnnotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CheckAnnotationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CheckAnnotation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CheckAnnotation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationPosition\n

\n

A character position in a check annotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

column (Int)

Column number (1 indexed).

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

Line number (1 indexed).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationSpan\n

\n

An inclusive pair of positions for a check annotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

end (CheckAnnotationPosition!)

End position (inclusive).

\n\n\n\n\n\n\n\n\n\n\n\n

start (CheckAnnotationPosition!)

Start position (inclusive).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckRun\n

\n

A check run.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotations (CheckAnnotationConnection)

The check run's annotations.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

checkSuite (CheckSuite!)

The check suite that this run is a part of.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

Identifies the date and time when the check run was completed.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The conclusion of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL from which to find full details of the check run on the integrator's site.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the check run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the check for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI!)

The permalink to the check run summary.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this check run.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

Identifies the date and time when the check run was started.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState!)

The current status of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String)

A string representing the check run's summary.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

A string representing the check run's text.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

A string representing the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckRunConnection\n

\n

The connection type for CheckRun.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CheckRunEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CheckRun])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckRunEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CheckRun)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckSuite\n

\n

A check suite.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

app (App)

The GitHub App which created this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

branch (Ref)

The name of the branch for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

checkRuns (CheckRunConnection)

The check runs associated with a check suite.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (CheckRunFilter)

\n

Filters the check runs by this type.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit!)

The commit for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The conclusion of this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

matchingPullRequests (PullRequestConnection)

A list of open pull requests matching the check suite.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

push (Push)

The push that triggered this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState!)

The status of this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckSuiteConnection\n

\n

The connection type for CheckSuite.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CheckSuiteEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CheckSuite])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckSuiteEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CheckSuite)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ClosedEvent\n

\n

Represents aclosedevent on any Closable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

closable (Closable!)

Object that was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

closer (Closer)

Object which triggered the creation of this event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this closed event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this closed event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CodeOfConduct\n

\n

The Code of Conduct for a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The key for the Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The formal name of the Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI)

The HTTP path for this Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI)

The HTTP URL for this Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommentDeletedEvent\n

\n

Represents acomment_deletedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deletedCommentAuthor (Actor)

The user who authored the deleted comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Commit\n

\n

Represents a Git commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

additions (Int!)

The number of additions in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

associatedPullRequests (PullRequestConnection)

The pull requests associated with a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (PullRequestOrder)

\n

Ordering options for pull requests.

\n\n
\n\n
\n\n\n

author (GitActor)

Authorship details of the commit.

\n\n\n\n\n\n\n\n\n\n\n\n

authoredByCommitter (Boolean!)

Check if the committer and the author match.

\n\n\n\n\n\n\n\n\n\n\n\n

authoredDate (DateTime!)

The datetime when this commit was authored.

\n\n\n\n\n\n\n\n\n\n\n\n

authors (GitActorConnection!)

The list of authors for this commit based on the git author and the Co-authored-by\nmessage trailer. The git author will always be first.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

blame (Blame!)

Fetches git blame information.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

path (String!)

\n

The file whose Git blame information you want.

\n\n
\n\n
\n\n\n

changedFiles (Int!)

The number of changed files in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

checkSuites (CheckSuiteConnection)

The check suites associated with a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (CheckSuiteFilter)

\n

Filters the check suites by this type.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

comments (CommitCommentConnection!)

Comments made on the commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

committedDate (DateTime!)

The datetime when this commit was committed.

\n\n\n\n\n\n\n\n\n\n\n\n

committedViaWeb (Boolean!)

Check if committed via GitHub web UI.

\n\n\n\n\n\n\n\n\n\n\n\n

committer (GitActor)

Committer details of the commit.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions (Int!)

The number of deletions in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

deployments (DeploymentConnection)

The deployments associated with a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

environments ([String!])

\n

Environments to list deployments for.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (DeploymentOrder)

\n

Ordering options for deployments returned from the connection.

\n\n
\n\n
\n\n\n

file (TreeEntry)

The tree entry representing the file located at the given path.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

path (String!)

\n

The path for the file.

\n\n
\n\n
\n\n\n

history (CommitHistoryConnection!)

The linear commit history starting from (and including) this commit, in the same order as git log.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

author (CommitAuthor)

\n

If non-null, filters history to only show commits with matching authorship.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

path (String)

\n

If non-null, filters history to only show commits touching files under this path.

\n\n
\n\n
\n

since (GitTimestamp)

\n

Allows specifying a beginning time or date for fetching commits.

\n\n
\n\n
\n

until (GitTimestamp)

\n

Allows specifying an ending time or date for fetching commits.

\n\n
\n\n
\n\n\n

message (String!)

The Git commit message.

\n\n\n\n\n\n\n\n\n\n\n\n

messageBody (String!)

The Git commit message body.

\n\n\n\n\n\n\n\n\n\n\n\n

messageBodyHTML (HTML!)

The commit message body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

messageHeadline (String!)

The Git commit message headline.

\n\n\n\n\n\n\n\n\n\n\n\n

messageHeadlineHTML (HTML!)

The commit message headline rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

onBehalfOf (Organization)

The organization this commit was made on behalf of.

\n\n\n\n\n\n\n\n\n\n\n\n

parents (CommitConnection!)

The parents of a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pushedDate (DateTime)

The datetime when this commit was pushed.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository this commit belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (GitSignature)

Commit signing information, if present.

\n\n\n\n\n\n\n\n\n\n\n\n

status (Status)

Status information for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

statusCheckRollup (StatusCheckRollup)

Check and Status rollup information for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

submodules (SubmoduleConnection!)

Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

tarballUrl (URI!)

Returns a URL to download a tarball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

\n\n\n\n\n\n\n\n\n\n\n\n

tree (Tree!)

Commit's root Tree.

\n\n\n\n\n\n\n\n\n\n\n\n

treeResourcePath (URI!)

The HTTP path for the tree of this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

treeUrl (URI!)

The HTTP URL for the tree of this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n

zipballUrl (URI!)

Returns a URL to download a zipball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitComment\n

\n

Represents a comment on a given Commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with the comment, if the commit exists.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

Identifies the file path associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

Identifies the line position associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path permalink for this commit comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL permalink for this commit comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitCommentConnection\n

\n

The connection type for CommitComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CommitCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CommitComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CommitComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitCommentThread\n

\n

A thread of comments on a commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (CommitCommentConnection!)

The comments that exist in this thread.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit)

The commit the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The file the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The position in the diff for the commit that the comment was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitConnection\n

\n

The connection type for Commit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CommitEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Commit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitContributionsByRepository\n

\n

This aggregates commits made by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedCommitContributionConnection!)

The commit contributions, each representing a day.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (CommitContributionOrder)

\n

Ordering options for commit contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the commits were made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for the user's commits to the repository in this time range.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for the user's commits to the repository in this time range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Commit)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitHistoryConnection\n

\n

The connection type for Commit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CommitEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Commit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ConnectedEvent\n

\n

Represents aconnectedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

source (ReferencedSubject!)

Issue or pull request that made the reference.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (ReferencedSubject!)

Issue or pull request which was connected.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContentAttachment\n

\n

A content attachment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body text of the content attachment. This parameter supports markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

contentReference (ContentReference!)

The content reference that the content attachment is attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int!)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the content attachment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContentReference\n

\n

A content reference.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

databaseId (Int!)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

reference (String!)

The reference of the content reference.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendar\n

\n

A calendar of contributions made on GitHub by a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

colors ([String!]!)

A list of hex color codes used in this calendar. The darker the color, the more contributions it represents.

\n\n\n\n\n\n\n\n\n\n\n\n

isHalloween (Boolean!)

Determine if the color set was chosen because it's currently Halloween.

\n\n\n\n\n\n\n\n\n\n\n\n

months ([ContributionCalendarMonth!]!)

A list of the months of contributions in this calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

totalContributions (Int!)

The count of total contributions in the calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

weeks ([ContributionCalendarWeek!]!)

A list of the weeks of contributions in this calendar.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendarDay\n

\n

Represents a single day of contributions on GitHub by a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

color (String!)

The hex color code that represents how many contributions were made on this day compared to others in the calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionCount (Int!)

How many contributions were made by the user on this day.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionLevel (ContributionLevel!)

Indication of contributions, relative to other days. Can be used to indicate\nwhich color to represent this day on a calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

date (Date!)

The day this square represents.

\n\n\n\n\n\n\n\n\n\n\n\n

weekday (Int!)

A number representing which day of the week this square represents, e.g., 1 is Monday.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendarMonth\n

\n

A month of contributions in a user's contribution graph.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

firstDay (Date!)

The date of the first day of this month.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the month.

\n\n\n\n\n\n\n\n\n\n\n\n

totalWeeks (Int!)

How many weeks started in this month.

\n\n\n\n\n\n\n\n\n\n\n\n

year (Int!)

The year the month occurred in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendarWeek\n

\n

A week of contributions in a user's contribution graph.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributionDays ([ContributionCalendarDay!]!)

The days of contributions in this week.

\n\n\n\n\n\n\n\n\n\n\n\n

firstDay (Date!)

The date of the earliest square in this week.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionsCollection\n

\n

A contributions collection aggregates contributions such as opened issues and commits created by a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commitContributionsByRepository ([CommitContributionsByRepository!]!)

Commit contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

contributionCalendar (ContributionCalendar!)

A calendar of this user's contributions on GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionYears ([Int!]!)

The years the user has been making contributions with the most recent year first.

\n\n\n\n\n\n\n\n\n\n\n\n

doesEndInCurrentMonth (Boolean!)

Determine if this collection's time span ends in the current month.

\n\n\n\n\n\n\n\n\n\n\n\n

earliestRestrictedContributionDate (Date)

The date of the first restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

endedAt (DateTime!)

The ending date and time of this collection.

\n\n\n\n\n\n\n\n\n\n\n\n

firstIssueContribution (CreatedIssueOrRestrictedContribution)

The first issue the user opened on GitHub. This will be null if that issue was\nopened outside the collection's time range and ignoreTimeRange is false. If\nthe issue is not visible but the user has opted to show private contributions,\na RestrictedContribution will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

firstPullRequestContribution (CreatedPullRequestOrRestrictedContribution)

The first pull request the user opened on GitHub. This will be null if that\npull request was opened outside the collection's time range and\nignoreTimeRange is not true. If the pull request is not visible but the user\nhas opted to show private contributions, a RestrictedContribution will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

firstRepositoryContribution (CreatedRepositoryOrRestrictedContribution)

The first repository the user created on GitHub. This will be null if that\nfirst repository was created outside the collection's time range and\nignoreTimeRange is false. If the repository is not visible, then a\nRestrictedContribution is returned.

\n\n\n\n\n\n\n\n\n\n\n\n

hasActivityInThePast (Boolean!)

Does the user have any more activity in the timeline that occurred prior to the collection's time range?.

\n\n\n\n\n\n\n\n\n\n\n\n

hasAnyContributions (Boolean!)

Determine if there are any contributions in this collection.

\n\n\n\n\n\n\n\n\n\n\n\n

hasAnyRestrictedContributions (Boolean!)

Determine if the user made any contributions in this time frame whose details\nare not visible because they were made in a private repository. Can only be\ntrue if the user enabled private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

isSingleDay (Boolean!)

Whether or not the collector's time span is all within the same day.

\n\n\n\n\n\n\n\n\n\n\n\n

issueContributions (CreatedIssueContributionConnection!)

A list of issues the user opened.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

issueContributionsByRepository ([IssueContributionsByRepository!]!)

Issue contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

joinedGitHubContribution (JoinedGitHubContribution)

When the user signed up for GitHub. This will be null if that sign up date\nfalls outside the collection's time range and ignoreTimeRange is false.

\n\n\n\n\n\n\n\n\n\n\n\n

latestRestrictedContributionDate (Date)

The date of the most recent restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

mostRecentCollectionWithActivity (ContributionsCollection)

When this collection's time range does not include any activity from the user, use this\nto get a different collection from an earlier time range that does have activity.

\n\n\n\n\n\n\n\n\n\n\n\n

mostRecentCollectionWithoutActivity (ContributionsCollection)

Returns a different contributions collection from an earlier time range than this one\nthat does not have any contributions.

\n\n\n\n\n\n\n\n\n\n\n\n

popularIssueContribution (CreatedIssueContribution)

The issue the user opened on GitHub that received the most comments in the specified\ntime frame.

\n\n\n\n\n\n\n\n\n\n\n\n

popularPullRequestContribution (CreatedPullRequestContribution)

The pull request the user opened on GitHub that received the most comments in the\nspecified time frame.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestContributions (CreatedPullRequestContributionConnection!)

Pull request contributions made by the user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

pullRequestContributionsByRepository ([PullRequestContributionsByRepository!]!)

Pull request contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

pullRequestReviewContributions (CreatedPullRequestReviewContributionConnection!)

Pull request review contributions made by the user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

pullRequestReviewContributionsByRepository ([PullRequestReviewContributionsByRepository!]!)

Pull request review contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

repositoryContributions (CreatedRepositoryContributionConnection!)

A list of repositories owned by the user that the user created in this time range.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first repository ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

restrictedContributionsCount (Int!)

A count of contributions made by the user that the viewer cannot access. Only\nnon-zero when the user has chosen to share their private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime!)

The beginning date and time of this collection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCommitContributions (Int!)

How many commits were made by the user in this time span.

\n\n\n\n\n\n\n\n\n\n\n\n

totalIssueContributions (Int!)

How many issues the user opened.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalPullRequestContributions (Int!)

How many pull requests the user opened.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalPullRequestReviewContributions (Int!)

How many pull request reviews the user left.

\n\n\n\n\n\n\n\n\n\n\n\n

totalRepositoriesWithContributedCommits (Int!)

How many different repositories the user committed to.

\n\n\n\n\n\n\n\n\n\n\n\n

totalRepositoriesWithContributedIssues (Int!)

How many different repositories the user opened issues in.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalRepositoriesWithContributedPullRequestReviews (Int!)

How many different repositories the user left pull request reviews in.

\n\n\n\n\n\n\n\n\n\n\n\n

totalRepositoriesWithContributedPullRequests (Int!)

How many different repositories the user opened pull requests in.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalRepositoryContributions (Int!)

How many repositories the user created.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first repository ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

user (User!)

The user who made the contributions in this collection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ConvertToDraftEvent\n

\n

Represents aconvert_to_draftevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this convert to draft event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this convert to draft event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ConvertedNoteToIssueEvent\n

\n

Represents aconverted_note_to_issueevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectCard (ProjectCard)

Project card referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedCommitContribution\n

\n

Represents the contribution a user made by committing to a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commitCount (Int!)

How many commits were made on this day to this repository by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository the user made a commit in.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedCommitContributionConnection\n

\n

The connection type for CreatedCommitContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedCommitContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedCommitContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of commits across days and repositories in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedCommitContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedCommitContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedIssueContribution\n

\n

Represents the contribution a user made on GitHub by opening an issue.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

The issue that was opened.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedIssueContributionConnection\n

\n

The connection type for CreatedIssueContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedIssueContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedIssueContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedIssueContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedIssueContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestContribution\n

\n

Represents the contribution a user made on GitHub by opening a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request that was opened.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestContributionConnection\n

\n

The connection type for CreatedPullRequestContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedPullRequestContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedPullRequestContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedPullRequestContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestReviewContribution\n

\n

Represents the contribution a user made by leaving a review on a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request the user reviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReview (PullRequestReview!)

The review the user left on the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository containing the pull request that the user reviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestReviewContributionConnection\n

\n

The connection type for CreatedPullRequestReviewContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedPullRequestReviewContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedPullRequestReviewContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestReviewContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedPullRequestReviewContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedRepositoryContribution\n

\n

Represents the contribution a user made on GitHub by creating a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository that was created.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedRepositoryContributionConnection\n

\n

The connection type for CreatedRepositoryContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedRepositoryContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedRepositoryContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedRepositoryContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedRepositoryContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CrossReferencedEvent\n

\n

Represents a mention made by one issue or pull request to another.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

referencedAt (DateTime!)

Identifies when the reference was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

source (ReferencedSubject!)

Issue or pull request that made the reference.

\n\n\n\n\n\n\n\n\n\n\n\n

target (ReferencedSubject!)

Issue or pull request to which the reference was made.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

willCloseTarget (Boolean!)

Checks if the target will be closed when the source is merged.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DemilestonedEvent\n

\n

Represents ademilestonedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneTitle (String!)

Identifies the milestone title associated with thedemilestonedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (MilestoneItem!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DependencyGraphDependency\n

\n

A dependency manifest entry.

\n
\n\n
\n \n
\n

Preview notice

\n

DependencyGraphDependency is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

hasDependencies (Boolean!)

Does the dependency itself have dependencies?.

\n\n\n\n\n\n\n\n\n\n\n\n

packageManager (String)

The dependency package manager.

\n\n\n\n\n\n\n\n\n\n\n\n

packageName (String!)

The required package name.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository containing the package.

\n\n\n\n\n\n\n\n\n\n\n\n

requirements (String!)

The dependency version requirements.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DependencyGraphDependencyConnection\n

\n

The connection type for DependencyGraphDependency.

\n
\n\n
\n \n
\n

Preview notice

\n

DependencyGraphDependencyConnection is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DependencyGraphDependencyEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([DependencyGraphDependency])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DependencyGraphDependencyEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n
\n

Preview notice

\n

DependencyGraphDependencyEdge is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (DependencyGraphDependency)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DependencyGraphManifest\n

\n

Dependency manifest for a repository.

\n
\n\n
\n \n
\n

Preview notice

\n

DependencyGraphManifest is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

blobPath (String!)

Path to view the manifest file blob.

\n\n\n\n\n\n\n\n\n\n\n\n

dependencies (DependencyGraphDependencyConnection)

A list of manifest dependencies.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

dependenciesCount (Int)

The number of dependencies listed in the manifest.

\n\n\n\n\n\n\n\n\n\n\n\n

exceedsMaxSize (Boolean!)

Is the manifest too big to parse?.

\n\n\n\n\n\n\n\n\n\n\n\n

filename (String!)

Fully qualified manifest filename.

\n\n\n\n\n\n\n\n\n\n\n\n

parseable (Boolean!)

Were we able to parse the manifest?.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository containing the manifest.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DependencyGraphManifestConnection\n

\n

The connection type for DependencyGraphManifest.

\n
\n\n
\n \n
\n

Preview notice

\n

DependencyGraphManifestConnection is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DependencyGraphManifestEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([DependencyGraphManifest])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DependencyGraphManifestEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n
\n

Preview notice

\n

DependencyGraphManifestEdge is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (DependencyGraphManifest)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployKey\n

\n

A repository deploy key.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The deploy key.

\n\n\n\n\n\n\n\n\n\n\n\n

readOnly (Boolean!)

Whether or not the deploy key is read only.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The deploy key title.

\n\n\n\n\n\n\n\n\n\n\n\n

verified (Boolean!)

Whether or not the deploy key has been verified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployKeyConnection\n

\n

The connection type for DeployKey.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeployKeyEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([DeployKey])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployKeyEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (DeployKey)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployedEvent\n

\n

Represents adeployedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deployment (Deployment!)

The deployment associated with thedeployedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

The ref associated with thedeployedevent.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Deployment\n

\n

Represents triggered deployment instance.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commit (Commit)

Identifies the commit sha of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOid (String!)

Identifies the oid of the deployment commit, even if the commit has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor!)

Identifies the actor who triggered the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The deployment description.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

The latest environment to which this deployment was made.

\n\n\n\n\n\n\n\n\n\n\n\n

latestEnvironment (String)

The latest environment to which this deployment was made.

\n\n\n\n\n\n\n\n\n\n\n\n

latestStatus (DeploymentStatus)

The latest status of this deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

originalEnvironment (String)

The original environment to which this deployment was made.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String)

Extra information that a deployment system might need.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the Ref of the deployment, if the deployment was created by ref.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

Identifies the repository associated with the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentState)

The current state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

statuses (DeploymentStatusConnection)

A list of statuses associated with the deployment.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

task (String)

The deployment task.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentConnection\n

\n

The connection type for Deployment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeploymentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Deployment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Deployment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentEnvironmentChangedEvent\n

\n

Represents adeployment_environment_changedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

deploymentStatus (DeploymentStatus!)

The deployment status that updated the deployment environment.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentStatus\n

\n

Describes the status of a given deployment attempt.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor!)

Identifies the actor who triggered the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

deployment (Deployment!)

Identifies the deployment associated with status.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Identifies the description of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

Identifies the environment of the deployment at the time of this deployment status.

\n\n\n\n\n
\n

Preview notice

\n

environment is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

environmentUrl (URI)

Identifies the environment URL of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

logUrl (URI)

Identifies the log URL of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentStatusState!)

Identifies the current state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentStatusConnection\n

\n

The connection type for DeploymentStatus.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeploymentStatusEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([DeploymentStatus])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentStatusEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (DeploymentStatus)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DisconnectedEvent\n

\n

Represents adisconnectedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

source (ReferencedSubject!)

Issue or pull request from which the issue was disconnected.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (ReferencedSubject!)

Issue or pull request which was disconnected.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Enterprise\n

\n

An account to manage multiple organizations with consolidated policy and billing.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the enterprise's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

billingInfo (EnterpriseBillingInfo)

Enterprise billing information visible to enterprise billing managers.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML!)

The description of the enterprise as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The location of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

members (EnterpriseMemberConnection!)

A list of users who are members of this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

deployment (EnterpriseUserDeployment)

\n

Only return members within the selected GitHub Enterprise deployment.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for members returned from the connection.

\n\n
\n\n
\n

organizationLogins ([String!])

\n

Only return members within the organizations with these logins.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseUserAccountMembershipRole)

\n

The role of the user in the enterprise organization or server.

\n\n
\n\n
\n\n\n

name (String!)

The name of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

organizations (OrganizationConnection!)

A list of organizations that belong to this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

ownerInfo (EnterpriseOwnerInfo)

Enterprise information only visible to enterprise owners.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

slug (String!)

The URL-friendly identifier for the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

userAccounts (EnterpriseUserAccountConnection!)

A list of user accounts on this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerIsAdmin (Boolean!)

Is the current viewer an admin of this enterprise?.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (URI)

The URL of the enterprise website.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseAdministratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorEdge\n

\n

A User who is an administrator of an enterprise.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole!)

The role of the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitation\n

\n

An invitation for a user to become an owner or billing manager of an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email of the person who was invited to the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise!)

The enterprise the invitation is for.

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (User)

The user who was invited to the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

inviter (User)

The user who created the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole!)

The invitee's pending role in the enterprise (owner or billing_manager).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationConnection\n

\n

The connection type for EnterpriseAdministratorInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseAdministratorInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseAdministratorInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseAdministratorInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseBillingInfo\n

\n

Enterprise billing information visible to enterprise billing managers and owners.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allLicensableUsersCount (Int!)

The number of licenseable users/emails across the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

assetPacks (Int!)

The number of data packs used by all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

availableSeats (Int!)

The number of available seats across all owned organizations based on the unique number of billable users.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

availableSeats is deprecated.

availableSeats will be replaced with totalAvailableLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalAvailableLicenses instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n

bandwidthQuota (Float!)

The bandwidth quota in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

bandwidthUsage (Float!)

The bandwidth usage in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

bandwidthUsagePercentage (Int!)

The bandwidth usage as a percentage of the bandwidth quota.

\n\n\n\n\n\n\n\n\n\n\n\n

seats (Int!)

The total seats across all organizations owned by the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

seats is deprecated.

seats will be replaced with totalLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalLicenses instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n

storageQuota (Float!)

The storage quota in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

storageUsage (Float!)

The storage usage in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

storageUsagePercentage (Int!)

The storage usage as a percentage of the storage quota.

\n\n\n\n\n\n\n\n\n\n\n\n

totalAvailableLicenses (Int!)

The number of available licenses across all owned organizations based on the unique number of billable users.

\n\n\n\n\n\n\n\n\n\n\n\n

totalLicenses (Int!)

The total number of licenses allocated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseIdentityProvider\n

\n

An identity provider configured to provision identities for an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

digestMethod (SamlDigestAlgorithm)

The digest algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise)

The enterprise this identity provider belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

externalIdentities (ExternalIdentityConnection!)

ExternalIdentities provisioned by this identity provider.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

idpCertificate (X509Certificate)

The x509 certificate used by the identity provider to sign assertions and responses.

\n\n\n\n\n\n\n\n\n\n\n\n

issuer (String)

The Issuer Entity ID for the SAML identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

recoveryCodes ([String!])

Recovery codes that can be used by admins to access the enterprise if the identity provider is unavailable.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethod (SamlSignatureAlgorithm)

The signature algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

ssoUrl (URI)

The URL endpoint for the identity provider's SAML SSO.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberConnection\n

\n

The connection type for EnterpriseMember.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseMemberEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseMember])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberEdge\n

\n

A User who is a member of an enterprise through one or more organizations.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the user does not have a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All members consume a license Removal on 2021-01-01 UTC.

\n
\n\n\n\n\n\n\n

node (EnterpriseMember)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOrganizationMembershipConnection\n

\n

The connection type for Organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseOrganizationMembershipEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Organization])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOrganizationMembershipEdge\n

\n

An enterprise organization that a user is a member of.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Organization)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseUserAccountMembershipRole!)

The role of the user in the enterprise membership.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOutsideCollaboratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseOutsideCollaboratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOutsideCollaboratorEdge\n

\n

A User who is an outside collaborator of an enterprise through one or more organizations.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the outside collaborator does not have a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All outside collaborators consume a license Removal on 2021-01-01 UTC.

\n
\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (EnterpriseRepositoryInfoConnection!)

The enterprise organization repositories this user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOwnerInfo\n

\n

Enterprise information only visible to enterprise owners.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

admins (EnterpriseAdministratorConnection!)

A list of all of the administrators for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for administrators returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseAdministratorRole)

\n

The role to filter by.

\n\n
\n\n
\n\n\n

affiliatedUsersWithTwoFactorDisabled (UserConnection!)

A list of users in the enterprise who currently have two-factor authentication disabled.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

affiliatedUsersWithTwoFactorDisabledExist (Boolean!)

Whether or not affiliated users with two-factor authentication disabled exist in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

allowPrivateRepositoryForkingSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether private repository forking is enabled for repositories in organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

allowPrivateRepositoryForkingSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided private repository forking setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

defaultRepositoryPermissionSetting (EnterpriseDefaultRepositoryPermissionSettingValue!)

The setting value for base repository permissions for organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

defaultRepositoryPermissionSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided default repository permission.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (DefaultRepositoryPermissionField!)

\n

The permission to find organizations for.

\n\n
\n\n
\n\n\n

domains (VerifiableDomainConnection!)

A list of domains owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isVerified (Boolean)

\n

Filter whether or not the domain is verified.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (VerifiableDomainOrder)

\n

Ordering options for verifiable domains returned.

\n\n
\n\n
\n\n\n

enterpriseServerInstallations (EnterpriseServerInstallationConnection!)

Enterprise Server installations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

connectedOnly (Boolean)

\n

Whether or not to only return installations discovered via GitHub Connect.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerInstallationOrder)

\n

Ordering options for Enterprise Server installations returned.

\n\n
\n\n
\n\n\n

ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

The setting value for whether the enterprise has an IP allow list enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntries (IpAllowListEntryConnection!)

The IP addresses that are allowed to access resources owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IpAllowListEntryOrder)

\n

Ordering options for IP allow list entries returned.

\n\n
\n\n
\n\n\n

isUpdatingDefaultRepositoryPermission (Boolean!)

Whether or not the default repository permission is currently being updated.

\n\n\n\n\n\n\n\n\n\n\n\n

isUpdatingTwoFactorRequirement (Boolean!)

Whether the two-factor authentication requirement is currently being enforced.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanChangeRepositoryVisibilitySetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether organization members with admin permissions on a\nrepository can change repository visibility.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanChangeRepositoryVisibilitySettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided can change repository visibility setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanCreateInternalRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create internal repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePrivateRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create private repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePublicRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create public repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesSetting (EnterpriseMembersCanCreateRepositoriesSettingValue)

The setting value for whether members of organizations in the enterprise can create repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided repository creation setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (OrganizationMembersCanCreateRepositoriesSettingValue!)

\n

The setting to find organizations for.

\n\n
\n\n
\n\n\n

membersCanDeleteIssuesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can delete issues.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanDeleteIssuesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can delete issues setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanDeleteRepositoriesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can delete or transfer repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanDeleteRepositoriesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can delete repositories setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanInviteCollaboratorsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members of organizations in the enterprise can invite outside collaborators.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanInviteCollaboratorsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can invite collaborators setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanMakePurchasesSetting (EnterpriseMembersCanMakePurchasesSettingValue!)

Indicates whether members of this enterprise's organizations can purchase additional services for those organizations.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanUpdateProtectedBranchesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can update protected branches.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanUpdateProtectedBranchesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can update protected branches setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanViewDependencyInsightsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members can view dependency insights.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanViewDependencyInsightsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can view dependency insights setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

notificationDeliveryRestrictionEnabledSetting (NotificationRestrictionSettingValue!)

Indicates if email notification delivery for this enterprise is restricted to verified domains.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether organization projects are enabled for organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationProjectsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided organization projects setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

outsideCollaborators (EnterpriseOutsideCollaboratorConnection!)

A list of outside collaborators across the repositories in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

login (String)

\n

The login of one specific outside collaborator.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for outside collaborators returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

visibility (RepositoryVisibility)

\n

Only return outside collaborators on repositories with this visibility.

\n\n
\n\n
\n\n\n

pendingAdminInvitations (EnterpriseAdministratorInvitationConnection!)

A list of pending administrator invitations for the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseAdministratorInvitationOrder)

\n

Ordering options for pending enterprise administrator invitations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseAdministratorRole)

\n

The role to filter by.

\n\n
\n\n
\n\n\n

pendingCollaboratorInvitations (RepositoryInvitationConnection!)

A list of pending collaborator invitations across the repositories in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryInvitationOrder)

\n

Ordering options for pending repository collaborator invitations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

pendingCollaborators (EnterprisePendingCollaboratorConnection!)

A list of pending collaborators across the repositories in the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

pendingCollaborators is deprecated.

Repository invitations can now be associated with an email, not only an invitee. Use the pendingCollaboratorInvitations field instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryInvitationOrder)

\n

Ordering options for pending repository collaborator invitations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

pendingMemberInvitations (EnterprisePendingMemberInvitationConnection!)

A list of pending member invitations for organizations in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

repositoryProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether repository projects are enabled in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryProjectsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided repository projects setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

samlIdentityProvider (EnterpriseIdentityProvider)

The SAML Identity Provider for the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

samlIdentityProviderSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the SAML single sign-on setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (IdentityProviderConfigurationState!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

supportEntitlements (EnterpriseMemberConnection!)

A list of members with a support entitlement.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for support entitlement users returned from the connection.

\n\n
\n\n
\n\n\n

teamDiscussionsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether team discussions are enabled for organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

teamDiscussionsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided team discussions setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

twoFactorRequiredSetting (EnterpriseEnabledSettingValue!)

The setting value for whether the enterprise requires two-factor authentication for its organizations and users.

\n\n\n\n\n\n\n\n\n\n\n\n

twoFactorRequiredSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the two-factor authentication setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingCollaboratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterprisePendingCollaboratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingCollaboratorEdge\n

\n

A user with an invitation to be a collaborator on a repository owned by an organization in an enterprise.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the invited collaborator does not have a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All pending collaborators consume a license Removal on 2021-01-01 UTC.

\n
\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (EnterpriseRepositoryInfoConnection!)

The enterprise organization repositories this user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingMemberInvitationConnection\n

\n

The connection type for OrganizationInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterprisePendingMemberInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([OrganizationInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalUniqueUserCount (Int!)

Identifies the total count of unique users in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingMemberInvitationEdge\n

\n

An invitation to be a member in an enterprise organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the invitation has a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All pending members consume a license Removal on 2020-07-01 UTC.

\n
\n\n\n\n\n\n\n

node (OrganizationInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseRepositoryInfo\n

\n

A subset of repository information queryable from an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isPrivate (Boolean!)

Identifies if the repository is private.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The repository's name.

\n\n\n\n\n\n\n\n\n\n\n\n

nameWithOwner (String!)

The repository's name with owner.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseRepositoryInfoConnection\n

\n

The connection type for EnterpriseRepositoryInfo.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseRepositoryInfoEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseRepositoryInfo])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseRepositoryInfoEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseRepositoryInfo)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerInstallation\n

\n

An Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

customerName (String!)

The customer name to which the Enterprise Server installation belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

hostName (String!)

The host name of the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

isConnected (Boolean!)

Whether or not the installation is connected to an Enterprise Server installation via GitHub Connect.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

userAccounts (EnterpriseServerUserAccountConnection!)

User accounts on this Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerUserAccountOrder)

\n

Ordering options for Enterprise Server user accounts returned from the connection.

\n\n
\n\n
\n\n\n

userAccountsUploads (EnterpriseServerUserAccountsUploadConnection!)

User accounts uploads for the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerUserAccountsUploadOrder)

\n

Ordering options for Enterprise Server user accounts uploads returned from the connection.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerInstallationConnection\n

\n

The connection type for EnterpriseServerInstallation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerInstallationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerInstallation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerInstallationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerInstallation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccount\n

\n

A user account on an Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

emails (EnterpriseServerUserAccountEmailConnection!)

User emails belonging to this user account.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerUserAccountEmailOrder)

\n

Ordering options for Enterprise Server user account emails returned from the connection.

\n\n
\n\n
\n\n\n

enterpriseServerInstallation (EnterpriseServerInstallation!)

The Enterprise Server installation on which this user account exists.

\n\n\n\n\n\n\n\n\n\n\n\n

isSiteAdmin (Boolean!)

Whether the user account is a site administrator on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user account on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

profileName (String)

The profile name of the user account on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

remoteCreatedAt (DateTime!)

The date and time when the user account was created on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

remoteUserId (Int!)

The ID of the user account on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountConnection\n

\n

The connection type for EnterpriseServerUserAccount.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerUserAccountEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerUserAccount])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerUserAccount)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmail\n

\n

An email belonging to a user account on an Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String!)

The email address.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrimary (Boolean!)

Indicates whether this is the primary email of the associated user account.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

userAccount (EnterpriseServerUserAccount!)

The user account to which the email belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailConnection\n

\n

The connection type for EnterpriseServerUserAccountEmail.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerUserAccountEmailEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerUserAccountEmail])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerUserAccountEmail)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUpload\n

\n

A user accounts upload from an Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise!)

The enterprise to which this upload belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseServerInstallation (EnterpriseServerInstallation!)

The Enterprise Server installation for which this upload was generated.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the file uploaded.

\n\n\n\n\n\n\n\n\n\n\n\n

syncState (EnterpriseServerUserAccountsUploadSyncState!)

The synchronization state of the upload.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadConnection\n

\n

The connection type for EnterpriseServerUserAccountsUpload.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerUserAccountsUploadEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerUserAccountsUpload])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerUserAccountsUpload)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseUserAccount\n

\n

An account for a user who is an admin of an enterprise or a member of an enterprise through one or more organizations.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the enterprise user account's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise!)

The enterprise in which this user account exists.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

An identifier for the enterprise user account, a login or email address.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the enterprise user account.

\n\n\n\n\n\n\n\n\n\n\n\n

organizations (EnterpriseOrganizationMembershipConnection!)

A list of enterprise organizations this user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseUserAccountMembershipRole)

\n

The role of the user in the enterprise organization.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user within the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseUserAccountConnection\n

\n

The connection type for EnterpriseUserAccount.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseUserAccountEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseUserAccount])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseUserAccountEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseUserAccount)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentity\n

\n

An external identity provisioned by SAML SSO or SCIM.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

guid (String!)

The GUID for this identity.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationInvitation (OrganizationInvitation)

Organization invitation for this SCIM-provisioned external identity.

\n\n\n\n\n\n\n\n\n\n\n\n

samlIdentity (ExternalIdentitySamlAttributes)

SAML Identity attributes.

\n\n\n\n\n\n\n\n\n\n\n\n

scimIdentity (ExternalIdentityScimAttributes)

SCIM Identity attributes.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentityConnection\n

\n

The connection type for ExternalIdentity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ExternalIdentityEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ExternalIdentity])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentityEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ExternalIdentity)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentitySamlAttributes\n

\n

SAML attributes for the External Identity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([UserEmailMetadata!])

The emails associated with the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

familyName (String)

Family name of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

givenName (String)

Given name of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

groups ([String!])

The groups linked to this identity in IDP.

\n\n\n\n\n\n\n\n\n\n\n\n

nameId (String)

The NameID of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

username (String)

The userName of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentityScimAttributes\n

\n

SCIM attributes for the External Identity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([UserEmailMetadata!])

The emails associated with the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n

familyName (String)

Family name of the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n

givenName (String)

Given name of the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n

groups ([String!])

The groups linked to this identity in IDP.

\n\n\n\n\n\n\n\n\n\n\n\n

username (String)

The userName of the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n FollowerConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n FollowingConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n FundingLink\n

\n

A funding platform link for a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

platform (FundingPlatform!)

The funding platform this link is for.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The configured URL for this funding link.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GenericHovercardContext\n

\n

A generic hovercard context with a message and icon.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Gist\n

\n

A Gist.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (GistCommentConnection!)

A list of comments associated with the gist.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The gist description.

\n\n\n\n\n\n\n\n\n\n\n\n

files ([GistFile])

The files in this gist.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

limit (Int)

\n

The maximum number of files to return.

\n

The default value is 10.

\n
\n\n
\n

oid (GitObjectID)

\n

The oid of the files to return.

\n\n
\n\n
\n\n\n

forks (GistConnection!)

A list of forks associated with the gist.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (GistOrder)

\n

Ordering options for gists returned from the connection.

\n\n
\n\n
\n\n\n

isFork (Boolean!)

Identifies if the gist is a fork.

\n\n\n\n\n\n\n\n\n\n\n\n

isPublic (Boolean!)

Whether the gist is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The gist name.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (RepositoryOwner)

The gist owner.

\n\n\n\n\n\n\n\n\n\n\n\n

pushedAt (DateTime)

Identifies when the gist was last pushed to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTML path to this resource.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this Gist.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistComment\n

\n

Represents a comment on an Gist.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the gist.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

gist (Gist!)

The associated gist.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistCommentConnection\n

\n

The connection type for GistComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([GistCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([GistComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (GistComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistConnection\n

\n

The connection type for Gist.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([GistEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Gist])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Gist)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistFile\n

\n

A file in a gist.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

encodedName (String)

The file name encoded to remove characters that are invalid in URL paths.

\n\n\n\n\n\n\n\n\n\n\n\n

encoding (String)

The gist file encoding.

\n\n\n\n\n\n\n\n\n\n\n\n

extension (String)

The file extension from the file name.

\n\n\n\n\n\n\n\n\n\n\n\n

isImage (Boolean!)

Indicates if this file is an image.

\n\n\n\n\n\n\n\n\n\n\n\n

isTruncated (Boolean!)

Whether the file's contents were truncated.

\n\n\n\n\n\n\n\n\n\n\n\n

language (Language)

The programming language this file is written in.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The gist file name.

\n\n\n\n\n\n\n\n\n\n\n\n

size (Int)

The gist file size in bytes.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

UTF8 text data or null if the file is binary.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

truncate (Int)

\n

Optionally truncate the returned file to this length.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitActor\n

\n

Represents an actor in a Git commit (ie. an author or committer).

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the author's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

date (GitTimestamp)

The timestamp of the Git action (authoring or committing).

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email in the Git commit.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name in the Git commit.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The GitHub user corresponding to the email field. Null if no such user exists.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitActorConnection\n

\n

The connection type for GitActor.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([GitActorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([GitActor])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitActorEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (GitActor)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitHubMetadata\n

\n

Represents information about the GitHub instance.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

gitHubServicesSha (GitObjectID!)

Returns a String that's a SHA of github-services.

\n\n\n\n\n\n\n\n\n\n\n\n

gitIpAddresses ([String!])

IP addresses that users connect to for git operations.

\n\n\n\n\n\n\n\n\n\n\n\n

hookIpAddresses ([String!])

IP addresses that service hooks are sent from.

\n\n\n\n\n\n\n\n\n\n\n\n

importerIpAddresses ([String!])

IP addresses that the importer connects from.

\n\n\n\n\n\n\n\n\n\n\n\n

isPasswordAuthenticationVerifiable (Boolean!)

Whether or not users are verified.

\n\n\n\n\n\n\n\n\n\n\n\n

pagesIpAddresses ([String!])

IP addresses for GitHub Pages' A records.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GpgSignature\n

\n

Represents a GPG signature on a Commit or Tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String!)

Email used to sign this object.

\n\n\n\n\n\n\n\n\n\n\n\n

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

keyId (String)

Hex-encoded ID of the key that signed this object.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (String!)

ASCII-armored signature header from object.

\n\n\n\n\n\n\n\n\n\n\n\n

signer (User)

GitHub user corresponding to the email signing this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

\n\n\n\n\n\n\n\n\n\n\n\n

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n HeadRefDeletedEvent\n

\n

Represents ahead_ref_deletedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

headRef (Ref)

Identifies the Ref associated with the head_ref_deleted event.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

Identifies the name of the Ref associated with the head_ref_deleted event.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n HeadRefForcePushedEvent\n

\n

Represents ahead_ref_force_pushedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

afterCommit (Commit)

Identifies the after commit SHA for thehead_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeCommit (Commit)

Identifies the before commit SHA for thehead_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the fully qualified ref name for thehead_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n HeadRefRestoredEvent\n

\n

Represents ahead_ref_restoredevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Hovercard\n

\n

Detail needed to display a hovercard for a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

contexts ([HovercardContext!]!)

Each of the contexts for this hovercard.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IpAllowListEntry\n

\n

An IP address or range of addresses that is allowed to access an owner's resources.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

A single IP address or range of IP addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the entry is currently active.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (IpAllowListOwner!)

The owner of the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryConnection\n

\n

The connection type for IpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IpAllowListEntryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IpAllowListEntry])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IpAllowListEntry)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Issue\n

\n

An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

activeLockReason (LockReason)

Reason that the conversation was locked.

\n\n\n\n\n\n\n\n\n\n\n\n

assignees (UserConnection!)

A list of Users assigned to this object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the body of the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyResourcePath (URI!)

The http path for this issue body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

Identifies the body of the issue rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyUrl (URI!)

The http URL for this issue body.

\n\n\n\n\n\n\n\n\n\n\n\n

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (IssueCommentConnection!)

A list of comments associated with the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueCommentOrder)

\n

Ordering options for issue comments returned from the connection.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

hovercard (Hovercard!)

The hovercard information for this issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

includeNotificationContexts (Boolean)

\n

Whether or not to include notification contexts.

\n

The default value is true.

\n
\n\n
\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isPinned (Boolean)

Indicates whether or not this issue is currently pinned to the repository issues list.

\n\n\n\n\n\n\n\n\n\n\n\n

isReadByViewer (Boolean)

Is this issue read by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

labels (LabelConnection)

A list of labels associated with the object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

locked (Boolean!)

true if the object is locked.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (Milestone)

Identifies the milestone associated with the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the issue number.

\n\n\n\n\n\n\n\n\n\n\n\n

participants (UserConnection!)

A list of Users that are participating in the Issue conversation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

projectCards (ProjectCardConnection!)

List of project cards associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

state (IssueState!)

Identifies the state of the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

timeline (IssueTimelineConnection!)

A list of events, comments, commits, etc. associated with the issue.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

timeline is deprecated.

timeline will be removed Use Issue.timelineItems instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Allows filtering timeline events by a since timestamp.

\n\n
\n\n
\n\n\n

timelineItems (IssueTimelineItemsConnection!)

A list of events, comments, commits, etc. associated with the issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

itemTypes ([IssueTimelineItemsItemType!])

\n

Filter timeline items by type.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Filter timeline items by a since timestamp.

\n\n
\n\n
\n

skip (Int)

\n

Skips the first n elements in the list.

\n\n
\n\n
\n\n\n

title (String!)

Identifies the issue title.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueComment\n

\n

Represents a comment on an Issue.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

Returns the pull request associated with the comment, if this comment was made on a\npull request.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this issue comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this issue comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueCommentConnection\n

\n

The connection type for IssueComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IssueComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IssueComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueConnection\n

\n

The connection type for Issue.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Issue])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueContributionsByRepository\n

\n

This aggregates issues opened by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedIssueContributionConnection!)

The issue contributions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the issues were opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Issue)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTemplate\n

\n

A repository issue template.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

about (String)

The template purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The suggested issue body.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The template name.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The suggested issue title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineConnection\n

\n

The connection type for IssueTimelineItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueTimelineItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IssueTimelineItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IssueTimelineItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineItemsConnection\n

\n

The connection type for IssueTimelineItems.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueTimelineItemsEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

filteredCount (Int!)

Identifies the count of items after applying before and after filters.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IssueTimelineItems])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageCount (Int!)

Identifies the count of items after applying before/after filters and first/last/skip slicing.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the timeline was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineItemsEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IssueTimelineItems)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n JoinedGitHubContribution\n

\n

Represents a user signing up for a GitHub account.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Label\n

\n

A label for categorizing Issues or Milestones with a given Repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

color (String!)

Identifies the label color.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime)

Identifies the date and time when the label was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of this label.

\n\n\n\n\n\n\n\n\n\n\n\n

isDefault (Boolean!)

Indicates whether or not this is a default label.

\n\n\n\n\n\n\n\n\n\n\n\n

issues (IssueConnection!)

A list of issues associated with this label.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

name (String!)

Identifies the label name.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests associated with this label.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this label.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this label.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime)

Identifies the date and time when the label was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LabelConnection\n

\n

The connection type for Label.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([LabelEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Label])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LabelEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Label)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LabeledEvent\n

\n

Represents alabeledevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

label (Label!)

Identifies the label associated with thelabeledevent.

\n\n\n\n\n\n\n\n\n\n\n\n

labelable (Labelable!)

Identifies the Labelable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Language\n

\n

Represents a given language found in repositories.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

color (String)

The color defined for the current language.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the current language.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LanguageConnection\n

\n

A list of languages associated with the parent.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([LanguageEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Language])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalSize (Int!)

The total size in bytes of files written in that language.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LanguageEdge\n

\n

Represents the language of a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

size (Int!)

The number of bytes of code written in the language.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n License\n

\n

A repository's open source license.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The full text of the license.

\n\n\n\n\n\n\n\n\n\n\n\n

conditions ([LicenseRule]!)

The conditions set by the license.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A human-readable description of the license.

\n\n\n\n\n\n\n\n\n\n\n\n

featured (Boolean!)

Whether the license should be featured.

\n\n\n\n\n\n\n\n\n\n\n\n

hidden (Boolean!)

Whether the license should be displayed in license pickers.

\n\n\n\n\n\n\n\n\n\n\n\n

implementation (String)

Instructions on how to implement the license.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The lowercased SPDX ID of the license.

\n\n\n\n\n\n\n\n\n\n\n\n

limitations ([LicenseRule]!)

The limitations set by the license.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The license full name specified by https://spdx.org/licenses.

\n\n\n\n\n\n\n\n\n\n\n\n

nickname (String)

Customary short name if applicable (e.g, GPLv3).

\n\n\n\n\n\n\n\n\n\n\n\n

permissions ([LicenseRule]!)

The permissions set by the license.

\n\n\n\n\n\n\n\n\n\n\n\n

pseudoLicense (Boolean!)

Whether the license is a pseudo-license placeholder (e.g., other, no-license).

\n\n\n\n\n\n\n\n\n\n\n\n

spdxId (String)

Short identifier specified by https://spdx.org/licenses.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI)

URL to the license on https://choosealicense.com.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LicenseRule\n

\n

Describes a License's conditions, permissions, and limitations.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String!)

A description of the rule.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The machine-readable rule key.

\n\n\n\n\n\n\n\n\n\n\n\n

label (String!)

The human-readable rule label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LockedEvent\n

\n

Represents alockedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (LockReason)

Reason that the conversation was locked (optional).

\n\n\n\n\n\n\n\n\n\n\n\n

lockable (Lockable!)

Object that was locked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Mannequin\n

\n

A placeholder user for attribution of imported data on GitHub.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the GitHub App's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The mannequin's email on the source instance.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The username of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTML path to this resource.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The URL to this resource.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MarkedAsDuplicateEvent\n

\n

Represents amarked_as_duplicateevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

canonical (IssueOrPullRequest)

The authoritative issue or pull request which has been duplicated by another.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicate (IssueOrPullRequest)

The issue or pull request which has been marked as a duplicate of another.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Canonical and duplicate belong to different repositories.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MarketplaceCategory\n

\n

A public description of a Marketplace category.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String)

The category's description.

\n\n\n\n\n\n\n\n\n\n\n\n

howItWorks (String)

The technical description of how apps listed in this category work with GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The category's name.

\n\n\n\n\n\n\n\n\n\n\n\n

primaryListingCount (Int!)

How many Marketplace listings have this as their primary category.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this Marketplace category.

\n\n\n\n\n\n\n\n\n\n\n\n

secondaryListingCount (Int!)

How many Marketplace listings have this as their secondary category.

\n\n\n\n\n\n\n\n\n\n\n\n

slug (String!)

The short name of the category used in its URL.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this Marketplace category.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MarketplaceListing\n

\n

A listing in the GitHub integration marketplace.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

app (App)

The GitHub App this listing represents.

\n\n\n\n\n\n\n\n\n\n\n\n

companyUrl (URI)

URL to the listing owner's company site.

\n\n\n\n\n\n\n\n\n\n\n\n

configurationResourcePath (URI!)

The HTTP path for configuring access to the listing's integration or OAuth app.

\n\n\n\n\n\n\n\n\n\n\n\n

configurationUrl (URI!)

The HTTP URL for configuring access to the listing's integration or OAuth app.

\n\n\n\n\n\n\n\n\n\n\n\n

documentationUrl (URI)

URL to the listing's documentation.

\n\n\n\n\n\n\n\n\n\n\n\n

extendedDescription (String)

The listing's detailed description.

\n\n\n\n\n\n\n\n\n\n\n\n

extendedDescriptionHTML (HTML!)

The listing's detailed description rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

fullDescription (String!)

The listing's introductory description.

\n\n\n\n\n\n\n\n\n\n\n\n

fullDescriptionHTML (HTML!)

The listing's introductory description rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

hasPublishedFreeTrialPlans (Boolean!)

Does this listing have any plans with a free trial?.

\n\n\n\n\n\n\n\n\n\n\n\n

hasTermsOfService (Boolean!)

Does this listing have a terms of service link?.

\n\n\n\n\n\n\n\n\n\n\n\n

hasVerifiedOwner (Boolean!)

Whether the creator of the app is a verified org.

\n\n\n\n\n\n\n\n\n\n\n\n

howItWorks (String)

A technical description of how this app works with GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

howItWorksHTML (HTML!)

The listing's technical description rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

installationUrl (URI)

URL to install the product to the viewer's account or organization.

\n\n\n\n\n\n\n\n\n\n\n\n

installedForViewer (Boolean!)

Whether this listing's app has been installed for the current viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean!)

Whether this listing has been removed from the Marketplace.

\n\n\n\n\n\n\n\n\n\n\n\n

isDraft (Boolean!)

Whether this listing is still an editable draft that has not been submitted\nfor review and is not publicly visible in the Marketplace.

\n\n\n\n\n\n\n\n\n\n\n\n

isPaid (Boolean!)

Whether the product this listing represents is available as part of a paid plan.

\n\n\n\n\n\n\n\n\n\n\n\n

isPublic (Boolean!)

Whether this listing has been approved for display in the Marketplace.

\n\n\n\n\n\n\n\n\n\n\n\n

isRejected (Boolean!)

Whether this listing has been rejected by GitHub for display in the Marketplace.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnverified (Boolean!)

Whether this listing has been approved for unverified display in the Marketplace.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnverifiedPending (Boolean!)

Whether this draft listing has been submitted for review for approval to be unverified in the Marketplace.

\n\n\n\n\n\n\n\n\n\n\n\n

isVerificationPendingFromDraft (Boolean!)

Whether this draft listing has been submitted for review from GitHub for approval to be verified in the Marketplace.

\n\n\n\n\n\n\n\n\n\n\n\n

isVerificationPendingFromUnverified (Boolean!)

Whether this unverified listing has been submitted for review from GitHub for approval to be verified in the Marketplace.

\n\n\n\n\n\n\n\n\n\n\n\n

isVerified (Boolean!)

Whether this listing has been approved for verified display in the Marketplace.

\n\n\n\n\n\n\n\n\n\n\n\n

logoBackgroundColor (String!)

The hex color code, without the leading '#', for the logo background.

\n\n\n\n\n\n\n\n\n\n\n\n

logoUrl (URI)

URL for the listing's logo image.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size in pixels of the resulting square image.

\n

The default value is 400.

\n
\n\n
\n\n\n

name (String!)

The listing's full name.

\n\n\n\n\n\n\n\n\n\n\n\n

normalizedShortDescription (String!)

The listing's very short description without a trailing period or ampersands.

\n\n\n\n\n\n\n\n\n\n\n\n

pricingUrl (URI)

URL to the listing's detailed pricing.

\n\n\n\n\n\n\n\n\n\n\n\n

primaryCategory (MarketplaceCategory!)

The category that best describes the listing.

\n\n\n\n\n\n\n\n\n\n\n\n

privacyPolicyUrl (URI!)

URL to the listing's privacy policy, may return an empty string for listings that do not require a privacy policy URL.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for the Marketplace listing.

\n\n\n\n\n\n\n\n\n\n\n\n

screenshotUrls ([String]!)

The URLs for the listing's screenshots.

\n\n\n\n\n\n\n\n\n\n\n\n

secondaryCategory (MarketplaceCategory)

An alternate category that describes the listing.

\n\n\n\n\n\n\n\n\n\n\n\n

shortDescription (String!)

The listing's very short description.

\n\n\n\n\n\n\n\n\n\n\n\n

slug (String!)

The short name of the listing used in its URL.

\n\n\n\n\n\n\n\n\n\n\n\n

statusUrl (URI)

URL to the listing's status page.

\n\n\n\n\n\n\n\n\n\n\n\n

supportEmail (String)

An email address for support for this listing's app.

\n\n\n\n\n\n\n\n\n\n\n\n

supportUrl (URI!)

Either a URL or an email address for support for this listing's app, may\nreturn an empty string for listings that do not require a support URL.

\n\n\n\n\n\n\n\n\n\n\n\n

termsOfServiceUrl (URI)

URL to the listing's terms of service.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for the Marketplace listing.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAddPlans (Boolean!)

Can the current viewer add plans for this Marketplace listing.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanApprove (Boolean!)

Can the current viewer approve this Marketplace listing.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanDelist (Boolean!)

Can the current viewer delist this Marketplace listing.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanEdit (Boolean!)

Can the current viewer edit this Marketplace listing.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanEditCategories (Boolean!)

Can the current viewer edit the primary and secondary category of this\nMarketplace listing.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanEditPlans (Boolean!)

Can the current viewer edit the plans for this Marketplace listing.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanRedraft (Boolean!)

Can the current viewer return this Marketplace listing to draft state\nso it becomes editable again.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReject (Boolean!)

Can the current viewer reject this Marketplace listing by returning it to\nan editable draft state or rejecting it entirely.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanRequestApproval (Boolean!)

Can the current viewer request this listing be reviewed for display in\nthe Marketplace as verified.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasPurchased (Boolean!)

Indicates whether the current user has an active subscription to this Marketplace listing.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasPurchasedForAllOrganizations (Boolean!)

Indicates if the current user has purchased a subscription to this Marketplace listing\nfor all of the organizations the user owns.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerIsListingAdmin (Boolean!)

Does the current viewer role allow them to administer this Marketplace listing.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MarketplaceListingConnection\n

\n

Look up Marketplace Listings.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([MarketplaceListingEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([MarketplaceListing])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MarketplaceListingEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (MarketplaceListing)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MembersCanDeleteReposClearAuditEntry\n

\n

Audit log entry for a members_can_delete_repos.clear event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MembersCanDeleteReposDisableAuditEntry\n

\n

Audit log entry for a members_can_delete_repos.disable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MembersCanDeleteReposEnableAuditEntry\n

\n

Audit log entry for a members_can_delete_repos.enable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MentionedEvent\n

\n

Represents amentionedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MergedEvent\n

\n

Represents amergedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with the merge event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeRef (Ref)

Identifies the Ref associated with the merge event.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeRefName (String!)

Identifies the name of the Ref associated with the merge event.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this merged event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this merged event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Milestone\n

\n

Represents a Milestone object on a given repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

Identifies the actor who created the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Identifies the description of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

dueOn (DateTime)

Identifies the due date of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

issues (IssueConnection!)

A list of issues associated with the milestone.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

number (Int!)

Identifies the number of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

progressPercentage (Float!)

Identifies the percentage complete for the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests associated with the milestone.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

state (MilestoneState!)

Identifies the state of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

Identifies the title of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this milestone.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MilestoneConnection\n

\n

The connection type for Milestone.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([MilestoneEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Milestone])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MilestoneEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Milestone)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MilestonedEvent\n

\n

Represents amilestonedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneTitle (String!)

Identifies the milestone title associated with themilestonedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (MilestoneItem!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MovedColumnsInProjectEvent\n

\n

Represents amoved_columns_in_projectevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

previousProjectColumnName (String!)

Column name the issue or pull request was moved from.

\n\n\n\n\n
\n

Preview notice

\n

previousProjectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectCard (ProjectCard)

Project card referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name the issue or pull request was moved to.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OauthApplicationCreateAuditEntry\n

\n

Audit log entry for a oauth_application.create event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

applicationUrl (URI)

The application URL of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

callbackUrl (URI)

The callback URL of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

rateLimit (Int)

The rate limit of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

state (OauthApplicationCreateAuditEntryState)

The state of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgAddBillingManagerAuditEntry\n

\n

Audit log entry for a org.add_billing_manager.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationEmail (String)

The email address used to invite a billing manager for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgAddMemberAuditEntry\n

\n

Audit log entry for a org.add_member.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (OrgAddMemberAuditEntryPermission)

The permission level of the member added to the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgBlockUserAuditEntry\n

\n

Audit log entry for a org.block_user.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUser (User)

The blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserName (String)

The username of the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserResourcePath (URI)

The HTTP path for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserUrl (URI)

The HTTP URL for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgConfigDisableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a org.config.disable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgConfigEnableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a org.config.enable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgCreateAuditEntry\n

\n

Audit log entry for a org.create event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

billingPlan (OrgCreateAuditEntryBillingPlan)

The billing plan for the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgDisableOauthAppRestrictionsAuditEntry\n

\n

Audit log entry for a org.disable_oauth_app_restrictions event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgDisableSamlAuditEntry\n

\n

Audit log entry for a org.disable_saml event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

digestMethodUrl (URI)

The SAML provider's digest algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

issuerUrl (URI)

The SAML provider's issuer URL.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethodUrl (URI)

The SAML provider's signature algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

singleSignOnUrl (URI)

The SAML provider's single sign-on URL.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgDisableTwoFactorRequirementAuditEntry\n

\n

Audit log entry for a org.disable_two_factor_requirement event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgEnableOauthAppRestrictionsAuditEntry\n

\n

Audit log entry for a org.enable_oauth_app_restrictions event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgEnableSamlAuditEntry\n

\n

Audit log entry for a org.enable_saml event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

digestMethodUrl (URI)

The SAML provider's digest algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

issuerUrl (URI)

The SAML provider's issuer URL.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethodUrl (URI)

The SAML provider's signature algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

singleSignOnUrl (URI)

The SAML provider's single sign-on URL.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgEnableTwoFactorRequirementAuditEntry\n

\n

Audit log entry for a org.enable_two_factor_requirement event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgInviteMemberAuditEntry\n

\n

Audit log entry for a org.invite_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email address of the organization invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationInvitation (OrganizationInvitation)

The organization invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgInviteToBusinessAuditEntry\n

\n

Audit log entry for a org.invite_to_business event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgOauthAppAccessApprovedAuditEntry\n

\n

Audit log entry for a org.oauth_app_access_approved event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgOauthAppAccessDeniedAuditEntry\n

\n

Audit log entry for a org.oauth_app_access_denied event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgOauthAppAccessRequestedAuditEntry\n

\n

Audit log entry for a org.oauth_app_access_requested event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRemoveBillingManagerAuditEntry\n

\n

Audit log entry for a org.remove_billing_manager event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (OrgRemoveBillingManagerAuditEntryReason)

The reason for the billing manager being removed.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRemoveMemberAuditEntry\n

\n

Audit log entry for a org.remove_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

membershipTypes ([OrgRemoveMemberAuditEntryMembershipType!])

The types of membership the member has with the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (OrgRemoveMemberAuditEntryReason)

The reason for the member being removed.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRemoveOutsideCollaboratorAuditEntry\n

\n

Audit log entry for a org.remove_outside_collaborator event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

membershipTypes ([OrgRemoveOutsideCollaboratorAuditEntryMembershipType!])

The types of membership the outside collaborator has with the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (OrgRemoveOutsideCollaboratorAuditEntryReason)

The reason for the outside collaborator being removed from the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberAuditEntry\n

\n

Audit log entry for a org.restore_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredCustomEmailRoutingsCount (Int)

The number of custom email routings for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredIssueAssignmentsCount (Int)

The number of issue assignments for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredMemberships ([OrgRestoreMemberAuditEntryMembership!])

Restored organization membership objects.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredMembershipsCount (Int)

The number of restored memberships.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredRepositoriesCount (Int)

The number of repositories of the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredRepositoryStarsCount (Int)

The number of starred repositories for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredRepositoryWatchesCount (Int)

The number of watched repositories for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberMembershipOrganizationAuditEntryData\n

\n

Metadata for an organization membership for org.restore_member actions.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberMembershipRepositoryAuditEntryData\n

\n

Metadata for a repository membership for org.restore_member actions.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberMembershipTeamAuditEntryData\n

\n

Metadata for a team membership for org.restore_member actions.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUnblockUserAuditEntry\n

\n

Audit log entry for a org.unblock_user.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUser (User)

The user being unblocked by the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserName (String)

The username of the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserResourcePath (URI)

The HTTP path for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserUrl (URI)

The HTTP URL for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateDefaultRepositoryPermissionAuditEntry\n

\n

Audit log entry for a org.update_default_repository_permission.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

The new default repository permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permissionWas (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

The former default repository permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateMemberAuditEntry\n

\n

Audit log entry for a org.update_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (OrgUpdateMemberAuditEntryPermission)

The new member permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permissionWas (OrgUpdateMemberAuditEntryPermission)

The former member permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateMemberRepositoryCreationPermissionAuditEntry\n

\n

Audit log entry for a org.update_member_repository_creation_permission event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

canCreateRepositories (Boolean)

Can members create repositories in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility)

The permission for visibility level of repositories for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateMemberRepositoryInvitationPermissionAuditEntry\n

\n

Audit log entry for a org.update_member_repository_invitation_permission event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

canInviteOutsideCollaboratorsToRepositories (Boolean)

Can outside collaborators be invited to repositories in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Organization\n

\n

An account on GitHub, with one or more owners, that has repositories, members and teams.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

anyPinnableItems (Boolean!)

Determine if this repository owner has any items that can be pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

type (PinnableItemType)

\n

Filter to only a particular kind of pinnable item.

\n\n
\n\n
\n\n\n

auditLog (OrganizationAuditEntryConnection!)

Audit log entries of the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (AuditLogOrder)

\n

Ordering options for the returned audit log entries.

\n\n
\n\n
\n

query (String)

\n

The query string to filter audit entries.

\n\n
\n\n
\n\n\n

avatarUrl (URI!)

A URL pointing to the organization's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The organization's public profile description.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (String)

The organization's public profile description rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

domains (VerifiableDomainConnection)

A list of domains owned by the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isVerified (Boolean)

\n

Filter by if the domain is verified.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (VerifiableDomainOrder)

\n

Ordering options for verifiable domains returned.

\n\n
\n\n
\n\n\n

email (String)

The organization's public email.

\n\n\n\n\n\n\n\n\n\n\n\n

hasSponsorsListing (Boolean!)

True if this user/organization has a GitHub Sponsors listing.

\n\n\n\n\n\n\n\n\n\n\n\n

interactionAbility (RepositoryInteractionAbility)

The interaction ability settings for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

The setting value for whether the organization has an IP allow list enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntries (IpAllowListEntryConnection!)

The IP addresses that are allowed to access resources owned by the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IpAllowListEntryOrder)

\n

Ordering options for IP allow list entries returned.

\n\n
\n\n
\n\n\n

isSponsoredBy (Boolean!)

Check if the given account is sponsoring this user/organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

accountLogin (String!)

\n

The target account's login.

\n\n
\n\n
\n\n\n

isSponsoringViewer (Boolean!)

True if the viewer is sponsored by this user/organization.

\n\n\n\n\n\n\n\n\n\n\n\n

isVerified (Boolean!)

Whether the organization has verified its profile email and website, always false on Enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

itemShowcase (ProfileItemShowcase!)

Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The organization's public profile location.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The organization's login name.

\n\n\n\n\n\n\n\n\n\n\n\n

memberStatuses (UserStatusConnection!)

Get the status messages members of this entity have set that are either public or visible only to the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (UserStatusOrder)

\n

Ordering options for user statuses returned from the connection.

\n\n
\n\n
\n\n\n

membersWithRole (OrganizationMemberConnection!)

A list of users who are members of this organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

name (String)

The organization's public profile name.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamResourcePath (URI!)

The HTTP path creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamUrl (URI!)

The HTTP URL creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

notificationDeliveryRestrictionEnabledSetting (NotificationRestrictionSettingValue!)

Indicates if email notification delivery for this organization is restricted to verified domains.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationBillingEmail (String)

The billing email for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

packages (PackageConnection!)

A list of packages under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

names ([String])

\n

Find packages by their names.

\n\n
\n\n
\n

orderBy (PackageOrder)

\n

Ordering of the returned packages.

\n\n
\n\n
\n

packageType (PackageType)

\n

Filter registry package by type.

\n\n
\n\n
\n

repositoryId (ID)

\n

Find packages in a repository by ID.

\n\n
\n\n
\n\n\n

pendingMembers (UserConnection!)

A list of users who have been invited to join this organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pinnableItems (PinnableItemConnection!)

A list of repositories and gists this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinnable items that are returned.

\n\n
\n\n
\n\n\n

pinnedItems (PinnableItemConnection!)

A list of repositories and gists this profile owner has pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinned items that are returned.

\n\n
\n\n
\n\n\n

pinnedItemsRemaining (Int!)

Returns how many more items this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Find project by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The project number to find.

\n\n
\n\n
\n\n\n

projects (ProjectConnection!)

A list of projects under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ProjectOrder)

\n

Ordering options for projects returned from the connection.

\n\n
\n\n
\n

search (String)

\n

Query to search projects by, currently only searching by name.

\n\n
\n\n
\n

states ([ProjectState!])

\n

A list of states to filter the projects by.

\n\n
\n\n
\n\n\n

projectsResourcePath (URI!)

The HTTP path listing organization's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

projectsUrl (URI!)

The HTTP URL listing organization's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (RepositoryConnection!)

A list of repositories that the user owns.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isFork (Boolean)

\n

If non-null, filters repositories according to whether they are forks of another repository.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

repository (Repository)

Find Repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

Name of Repository to find.

\n\n
\n\n
\n\n\n

requiresTwoFactorAuthentication (Boolean)

When true the organization requires all members, billing managers, and outside\ncollaborators to enable two-factor authentication.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

samlIdentityProvider (OrganizationIdentityProvider)

The Organization's SAML identity providers.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorsListing (SponsorsListing)

The GitHub Sponsors listing for this user or organization.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorshipForViewerAsSponsor (Sponsorship)

The viewer's sponsorship of this entity.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorshipsAsMaintainer (SponsorshipConnection!)

This object's sponsorships as the maintainer.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includePrivate (Boolean)

\n

Whether or not to include private sponsorships in the result set.

\n

The default value is false.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

sponsorshipsAsSponsor (SponsorshipConnection!)

This object's sponsorships as the sponsor.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

team (Team)

Find an organization's team by its slug.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

slug (String!)

\n

The name or slug of the team to find.

\n\n
\n\n
\n\n\n

teams (TeamConnection!)

A list of teams in this organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

ldapMapped (Boolean)

\n

If true, filters teams that are mapped to an LDAP Group (Enterprise only).

\n\n
\n\n
\n

orderBy (TeamOrder)

\n

Ordering options for teams returned from the connection.

\n\n
\n\n
\n

privacy (TeamPrivacy)

\n

If non-null, filters teams according to privacy.

\n\n
\n\n
\n

query (String)

\n

If non-null, filters teams with query on team name and team slug.

\n\n
\n\n
\n

role (TeamRole)

\n

If non-null, filters teams according to whether the viewer is an admin or member on team.

\n\n
\n\n
\n

rootTeamsOnly (Boolean)

\n

If true, restrict to only root teams.

\n

The default value is false.

\n
\n\n
\n

userLogins ([String!])

\n

User logins to filter by.

\n\n
\n\n
\n\n\n

teamsResourcePath (URI!)

The HTTP path listing organization's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsUrl (URI!)

The HTTP URL listing organization's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

twitterUsername (String)

The organization's Twitter username.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAdminister (Boolean!)

Organization is adminable by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanChangePinnedItems (Boolean!)

Can the viewer pin repositories and gists to the profile?.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateRepositories (Boolean!)

Viewer can create repositories on this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateTeams (Boolean!)

Viewer can create teams on this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSponsor (Boolean!)

Whether or not the viewer is able to sponsor this user/organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerIsAMember (Boolean!)

Viewer is an active member of this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerIsSponsoring (Boolean!)

True if the viewer is sponsoring this user/organization.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (URI)

The organization's public profile URL.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationAuditEntryConnection\n

\n

The connection type for OrganizationAuditEntry.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationAuditEntryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([OrganizationAuditEntry])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationAuditEntryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (OrganizationAuditEntry)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationConnection\n

\n

The connection type for Organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Organization])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Organization)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationIdentityProvider\n

\n

An Identity Provider configured to provision SAML and SCIM identities for Organizations.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

digestMethod (URI)

The digest algorithm used to sign SAML requests for the Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n\n

externalIdentities (ExternalIdentityConnection!)

External Identities provisioned by this Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

idpCertificate (X509Certificate)

The x509 certificate used by the Identity Provider to sign assertions and responses.

\n\n\n\n\n\n\n\n\n\n\n\n

issuer (String)

The Issuer Entity ID for the SAML Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

Organization this Identity Provider belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethod (URI)

The signature algorithm used to sign SAML requests for the Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n\n

ssoUrl (URI)

The URL endpoint for the Identity Provider's SAML SSO.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationInvitation\n

\n

An Invitation for a user to an organization.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email address of the user invited to the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationType (OrganizationInvitationType!)

The type of invitation that was sent (e.g. email, user).

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (User)

The user who was invited to the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

inviter (User!)

The user who created the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization!)

The organization the invite is for.

\n\n\n\n\n\n\n\n\n\n\n\n

role (OrganizationInvitationRole!)

The user's pending role in the organization (e.g. member, owner).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationInvitationConnection\n

\n

The connection type for OrganizationInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([OrganizationInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationInvitationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (OrganizationInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationMemberConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationMemberEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationMemberEdge\n

\n

Represents a user within an organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

hasTwoFactorEnabled (Boolean)

Whether the organization member has two factor enabled or not. Returns null if information is not available to viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

role (OrganizationMemberRole)

The role this user has in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationTeamsHovercardContext\n

\n

An organization teams hovercard context.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

relevantTeams (TeamConnection!)

Teams in this organization the user is a member of that are relevant.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

teamsResourcePath (URI!)

The path for the full team list for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsUrl (URI!)

The URL for the full team list for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

totalTeamCount (Int!)

The total number of teams the user is on in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationsHovercardContext\n

\n

An organization list hovercard context.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

relevantOrganizations (OrganizationConnection!)

Organizations this user is a member of that are relevant.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

totalOrganizationCount (Int!)

The total number of organizations this user is in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Package\n

\n

Information for an uploaded package.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

latestVersion (PackageVersion)

Find the latest version for the package.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Identifies the name of the package.

\n\n\n\n\n\n\n\n\n\n\n\n

packageType (PackageType!)

Identifies the type of the package.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository this package belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

statistics (PackageStatistics)

Statistics about package activity.

\n\n\n\n\n\n\n\n\n\n\n\n

version (PackageVersion)

Find package version by version string.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

version (String!)

\n

The package version.

\n\n
\n\n
\n\n\n

versions (PackageVersionConnection!)

list of versions for this package.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (PackageVersionOrder)

\n

Ordering of the returned packages.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageConnection\n

\n

The connection type for Package.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PackageEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Package])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Package)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageFile\n

\n

A file in a package version.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

md5 (String)

MD5 hash of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Name of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

packageVersion (PackageVersion)

The package version this file belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

sha1 (String)

SHA1 hash of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

sha256 (String)

SHA256 hash of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

size (Int)

Size of the file in bytes.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI)

URL to download the asset.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageFileConnection\n

\n

The connection type for PackageFile.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PackageFileEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PackageFile])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageFileEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PackageFile)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageStatistics\n

\n

Represents a object that contains package activity statistics such as downloads.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

downloadsTotalCount (Int!)

Number of times the package was downloaded since it was created.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageTag\n

\n

A version tag contains the mapping between a tag name and a version.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

name (String!)

Identifies the tag name of the version.

\n\n\n\n\n\n\n\n\n\n\n\n

version (PackageVersion)

Version that the tag is associated with.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageVersion\n

\n

Information about a specific package version.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

files (PackageFileConnection!)

List of files associated with this package version.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (PackageFileOrder)

\n

Ordering of the returned package files.

\n\n
\n\n
\n\n\n

package (Package)

The package associated with this version.

\n\n\n\n\n\n\n\n\n\n\n\n

platform (String)

The platform this version was built for.

\n\n\n\n\n\n\n\n\n\n\n\n

preRelease (Boolean!)

Whether or not this version is a pre-release.

\n\n\n\n\n\n\n\n\n\n\n\n

readme (String)

The README of this package version.

\n\n\n\n\n\n\n\n\n\n\n\n

release (Release)

The release associated with this package version.

\n\n\n\n\n\n\n\n\n\n\n\n

statistics (PackageVersionStatistics)

Statistics about package activity.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String)

The package version summary.

\n\n\n\n\n\n\n\n\n\n\n\n

version (String!)

The version string.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageVersionConnection\n

\n

The connection type for PackageVersion.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PackageVersionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PackageVersion])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageVersionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PackageVersion)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PackageVersionStatistics\n

\n

Represents a object that contains package version activity statistics such as downloads.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

downloadsTotalCount (Int!)

Number of times the package was downloaded since it was created.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PageInfo\n

\n

Information about pagination in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

endCursor (String)

When paginating forwards, the cursor to continue.

\n\n\n\n\n\n\n\n\n\n\n\n

hasNextPage (Boolean!)

When paginating forwards, are there more items?.

\n\n\n\n\n\n\n\n\n\n\n\n

hasPreviousPage (Boolean!)

When paginating backwards, are there more items?.

\n\n\n\n\n\n\n\n\n\n\n\n

startCursor (String)

When paginating backwards, the cursor to continue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PermissionSource\n

\n

A level of permission and source for a user's access to a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

organization (Organization!)

The organization the repository belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (DefaultRepositoryPermissionField!)

The level of access this source has granted to the user.

\n\n\n\n\n\n\n\n\n\n\n\n

source (PermissionGranter!)

The source of this permission.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnableItemConnection\n

\n

The connection type for PinnableItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PinnableItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PinnableItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnableItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PinnableItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedEvent\n

\n

Represents apinnedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedIssue\n

\n

A Pinned Issue is a issue pinned to a repository's index page.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

The issue that was pinned.

\n\n\n\n\n\n\n\n\n\n\n\n

pinnedBy (Actor!)

The actor that pinned this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository that this issue was pinned to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedIssueConnection\n

\n

The connection type for PinnedIssue.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PinnedIssueEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PinnedIssue])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedIssueEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PinnedIssue)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PrivateRepositoryForkingDisableAuditEntry\n

\n

Audit log entry for a private_repository_forking.disable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PrivateRepositoryForkingEnableAuditEntry\n

\n

Audit log entry for a private_repository_forking.enable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProfileItemShowcase\n

\n

A curatable list of repositories relating to a repository owner, which defaults\nto showing the most popular repositories they own.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

hasPinnedItems (Boolean!)

Whether or not the owner has pinned any repositories or gists.

\n\n\n\n\n\n\n\n\n\n\n\n

items (PinnableItemConnection!)

The repositories and gists in the showcase. If the profile owner has any\npinned items, those will be returned. Otherwise, the profile owner's popular\nrepositories will be returned.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Project\n

\n

Projects manage issues, pull requests and notes within a project owner.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The project's description body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The projects description body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

columns (ProjectColumnConnection!)

List of columns in the project.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

The actor who originally created the project.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The project's name.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

The project's number.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (ProjectOwner!)

The project's owner. Currently limited to repositories, organizations, and users.

\n\n\n\n\n\n\n\n\n\n\n\n

pendingCards (ProjectCardConnection!)

List of pending cards in this project.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

progress (ProjectProgress!)

Project progress details.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this project.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectState!)

Whether the project is open or closed.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this project.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectCard\n

\n

A card in a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

column (ProjectColumn)

The project column this card is associated under. A card may only belong to one\nproject column at a time. The column field will be null if the card is created\nin a pending state and has yet to be associated with a column. Once cards are\nassociated with a column, they will not become pending in the future.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ProjectCardItem)

The card content item.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

The actor who created this card.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean!)

Whether the card is archived.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The card note.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project!)

The project that contains this card.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this card.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectCardState)

The state of ProjectCard.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this card.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectCardConnection\n

\n

The connection type for ProjectCard.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ProjectCardEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ProjectCard])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectCardEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ProjectCard)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectColumn\n

\n

A column inside a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cards (ProjectCardConnection!)

List of cards in the column.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The project column's name.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project!)

The project that contains this column.

\n\n\n\n\n\n\n\n\n\n\n\n

purpose (ProjectColumnPurpose)

The semantic purpose of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this project column.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this project column.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectColumnConnection\n

\n

The connection type for ProjectColumn.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ProjectColumnEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ProjectColumn])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectColumnEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ProjectColumn)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectConnection\n

\n

A list of projects associated with the owner.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ProjectEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Project])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Project)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectProgress\n

\n

Project progress stats.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

doneCount (Int!)

The number of done cards.

\n\n\n\n\n\n\n\n\n\n\n\n

donePercentage (Float!)

The percentage of done cards.

\n\n\n\n\n\n\n\n\n\n\n\n

enabled (Boolean!)

Whether progress tracking is enabled and cards with purpose exist for this project.

\n\n\n\n\n\n\n\n\n\n\n\n

inProgressCount (Int!)

The number of in-progress cards.

\n\n\n\n\n\n\n\n\n\n\n\n

inProgressPercentage (Float!)

The percentage of in-progress cards.

\n\n\n\n\n\n\n\n\n\n\n\n

todoCount (Int!)

The number of to do cards.

\n\n\n\n\n\n\n\n\n\n\n\n

todoPercentage (Float!)

The percentage of to do cards.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PublicKey\n

\n

A user's public key.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

accessedAt (DateTime)

The last time this authorization was used to perform an action. Values will be null for keys not owned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime)

Identifies the date and time when the key was created. Keys created before\nMarch 5th, 2014 have inaccurate values. Values will be null for keys not owned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

fingerprint (String!)

The fingerprint for this PublicKey.

\n\n\n\n\n\n\n\n\n\n\n\n

isReadOnly (Boolean)

Whether this PublicKey is read-only or not. Values will be null for keys not owned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The public key string.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime)

Identifies the date and time when the key was updated. Keys created before\nMarch 5th, 2014 may have inaccurate values. Values will be null for keys not\nowned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PublicKeyConnection\n

\n

The connection type for PublicKey.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PublicKeyEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PublicKey])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PublicKeyEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PublicKey)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequest\n

\n

A repository pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

activeLockReason (LockReason)

Reason that the conversation was locked.

\n\n\n\n\n\n\n\n\n\n\n\n

additions (Int!)

The number of additions in this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

assignees (UserConnection!)

A list of Users assigned to this object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

autoMergeRequest (AutoMergeRequest)

Returns the auto-merge request object if one exists for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRef (Ref)

Identifies the base Ref associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String!)

Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefOid (GitObjectID!)

Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRepository (Repository)

The repository associated with this pull request's base Ref.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

canBeRebased (Boolean!)

Whether or not the pull request is rebaseable.

\n\n\n\n\n
\n

Preview notice

\n

canBeRebased is available under the Merge info preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

changedFiles (Int!)

The number of changed files in this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

checksResourcePath (URI!)

The HTTP path for the checks of this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

checksUrl (URI!)

The HTTP URL for the checks of this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

closed (Boolean!)

true if the pull request is closed.

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (IssueCommentConnection!)

A list of comments associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueCommentOrder)

\n

Ordering options for issue comments returned from the connection.

\n\n
\n\n
\n\n\n

commits (PullRequestCommitConnection!)

A list of commits present in this pull request's head branch not present in the base branch.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions (Int!)

The number of deletions in this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited this pull request's body.

\n\n\n\n\n\n\n\n\n\n\n\n

files (PullRequestChangedFileConnection)

Lists the files changed within this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

headRef (Ref)

Identifies the head Ref associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefOid (GitObjectID!)

Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

headRepository (Repository)

The repository associated with this pull request's head Ref.

\n\n\n\n\n\n\n\n\n\n\n\n

headRepositoryOwner (RepositoryOwner)

The owner of the repository associated with this pull request's head Ref.

\n\n\n\n\n\n\n\n\n\n\n\n

hovercard (Hovercard!)

The hovercard information for this issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

includeNotificationContexts (Boolean)

\n

Whether or not to include notification contexts.

\n

The default value is true.

\n
\n\n
\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

The head and base repositories are different.

\n\n\n\n\n\n\n\n\n\n\n\n

isDraft (Boolean!)

Identifies if the pull request is a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

isReadByViewer (Boolean)

Is this pull request read by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

labels (LabelConnection)

A list of labels associated with the object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

latestOpinionatedReviews (PullRequestReviewConnection)

A list of latest reviews per user associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

writersOnly (Boolean)

\n

Only return reviews from user who have write access to the repository.

\n

The default value is false.

\n
\n\n
\n\n\n

latestReviews (PullRequestReviewConnection)

A list of latest reviews per user associated with the pull request that are not also pending review.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

locked (Boolean!)

true if the pull request is locked.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean!)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeCommit (Commit)

The commit that was created when this pull request was merged.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeStateStatus (MergeStateStatus!)

Detailed information about the current pull request merge state status.

\n\n\n\n\n
\n

Preview notice

\n

mergeStateStatus is available under the Merge info preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

mergeable (MergeableState!)

Whether or not the pull request can be merged based on the existence of merge conflicts.

\n\n\n\n\n\n\n\n\n\n\n\n

merged (Boolean!)

Whether or not the pull request was merged.

\n\n\n\n\n\n\n\n\n\n\n\n

mergedAt (DateTime)

The date and time that the pull request was merged.

\n\n\n\n\n\n\n\n\n\n\n\n

mergedBy (Actor)

The actor who merged the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (Milestone)

Identifies the milestone associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the pull request number.

\n\n\n\n\n\n\n\n\n\n\n\n

participants (UserConnection!)

A list of Users that are participating in the Pull Request conversation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

permalink (URI!)

The permalink to the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

potentialMergeCommit (Commit)

The commit that GitHub automatically generated to test if this pull request\ncould be merged. This field will not return a value if the pull request is\nmerged, or if the test merge commit is still being generated. See the\nmergeable field for more details on the mergeability of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCards (ProjectCardConnection!)

List of project cards associated with this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

revertResourcePath (URI!)

The HTTP path for reverting this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

revertUrl (URI!)

The HTTP URL for reverting this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDecision (PullRequestReviewDecision)

The current status of this pull request with respect to code review.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewRequests (ReviewRequestConnection)

A list of review requests associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

reviewThreads (PullRequestReviewThreadConnection!)

The list of all review threads for this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

reviews (PullRequestReviewConnection)

A list of reviews associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

author (String)

\n

Filter by author of the review.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

states ([PullRequestReviewState!])

\n

A list of states to filter the reviews.

\n\n
\n\n
\n\n\n

state (PullRequestState!)

Identifies the state of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

suggestedReviewers ([SuggestedReviewer]!)

A list of reviewer suggestions based on commit history and past review comments.

\n\n\n\n\n\n\n\n\n\n\n\n

timeline (PullRequestTimelineConnection!)

A list of events, comments, commits, etc. associated with the pull request.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

timeline is deprecated.

timeline will be removed Use PullRequest.timelineItems instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Allows filtering timeline events by a since timestamp.

\n\n
\n\n
\n\n\n

timelineItems (PullRequestTimelineItemsConnection!)

A list of events, comments, commits, etc. associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

itemTypes ([PullRequestTimelineItemsItemType!])

\n

Filter timeline items by type.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Filter timeline items by a since timestamp.

\n\n
\n\n
\n

skip (Int)

\n

Skips the first n elements in the list.

\n\n
\n\n
\n\n\n

title (String!)

Identifies the pull request title.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanApplySuggestion (Boolean!)

Whether or not the viewer can apply suggestion.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanDeleteHeadRef (Boolean!)

Check if the viewer can restore the deleted head ref.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanDisableAutoMerge (Boolean!)

Whether or not the viewer can disable auto-merge.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanEnableAutoMerge (Boolean!)

Whether or not the viewer can enable auto-merge.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerMergeBodyText (String!)

The merge body text for the viewer and method.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

mergeType (PullRequestMergeMethod)

\n

The merge method for the message.

\n\n
\n\n
\n\n\n

viewerMergeHeadlineText (String!)

The merge headline text for the viewer and method.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

mergeType (PullRequestMergeMethod)

\n

The merge method for the message.

\n\n
\n\n
\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestChangedFile\n

\n

A file changed in a pull request.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

additions (Int!)

The number of additions to the file.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions (Int!)

The number of deletions to the file.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerViewedState (FileViewedState!)

The state of the file for the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestChangedFileConnection\n

\n

The connection type for PullRequestChangedFile.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestChangedFileEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestChangedFile])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestChangedFileEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestChangedFile)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommit\n

\n

Represents a Git commit part of a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commit (Commit!)

The Git commit object.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request this commit belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this pull request commit.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this pull request commit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommitCommentThread\n

\n

Represents a commit comment thread part of a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (CommitCommentConnection!)

The comments that exist in this thread.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit!)

The commit the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The file the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The position in the diff for the commit that the comment was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request this commit comment thread belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommitConnection\n

\n

The connection type for PullRequestCommit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestCommitEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestCommit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommitEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestCommit)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestConnection\n

\n

The connection type for PullRequest.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequest])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestContributionsByRepository\n

\n

This aggregates pull requests opened by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedPullRequestContributionConnection!)

The pull request contributions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the pull requests were opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequest)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReview\n

\n

A review object for a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorCanPushToRepository (Boolean!)

Indicates whether the author of this review has push access to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the pull request review body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body of this review rendered as plain text.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (PullRequestReviewCommentConnection!)

A list of review comments for the current pull request review.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit)

Identifies the commit associated with this pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

onBehalfOf (TeamConnection!)

A list of teams that this review was made on behalf of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

Identifies the pull request associated with this pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path permalink for this PullRequestReview.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestReviewState!)

Identifies the current state of the pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

submittedAt (DateTime)

Identifies when the Pull Request Review was submitted.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL permalink for this PullRequestReview.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewComment\n

\n

A review comment associated with a given repository pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The comment body of this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The comment body of this review comment rendered as plain text.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies when the comment was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

diffHunk (String!)

The diff hunk to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

draftedAt (DateTime!)

Identifies when the comment was created in a draft state.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

originalCommit (Commit)

Identifies the original commit associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

originalPosition (Int!)

The original line index in the diff to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

outdated (Boolean!)

Identifies when the comment body is outdated.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The line index in the diff to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request associated with this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReview (PullRequestReview)

The pull request review associated with this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

replyTo (PullRequestReviewComment)

The comment this is a reply to.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path permalink for this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestReviewCommentState!)

Identifies the state of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies when the comment was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL permalink for this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewCommentConnection\n

\n

The connection type for PullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestReviewCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestReviewComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestReviewComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewConnection\n

\n

The connection type for PullRequestReview.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestReviewEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestReview])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewContributionsByRepository\n

\n

This aggregates pull request reviews made by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedPullRequestReviewContributionConnection!)

The pull request review contributions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the pull request reviews were made.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestReview)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewThread\n

\n

A threaded list of comments for a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (PullRequestReviewCommentConnection!)

A list of pull request comments associated with the thread.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

skip (Int)

\n

Skips the first n elements in the list.

\n\n
\n\n
\n\n\n

diffSide (DiffSide!)

The side of the diff on which this thread was placed.

\n\n\n\n\n\n\n\n\n\n\n\n

isCollapsed (Boolean!)

Whether or not the thread has been collapsed (outdated or resolved).

\n\n\n\n\n\n\n\n\n\n\n\n

isOutdated (Boolean!)

Indicates whether this thread was outdated by newer changes.

\n\n\n\n\n\n\n\n\n\n\n\n

isResolved (Boolean!)

Whether this thread has been resolved.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int)

The line in the file to which this thread refers.

\n\n\n\n\n\n\n\n\n\n\n\n

originalLine (Int)

The original line in the file to which this thread refers.

\n\n\n\n\n\n\n\n\n\n\n\n

originalStartLine (Int)

The original start line in the file to which this thread refers (multi-line only).

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Identifies the file path of this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

Identifies the pull request associated with this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

Identifies the repository associated with this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

resolvedBy (User)

The user who resolved this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

startDiffSide (DiffSide)

The side of the diff that the first line of the thread starts on (multi-line only).

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The start line in the file to which this thread refers (multi-line only).

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReply (Boolean!)

Indicates whether the current viewer can reply to this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanResolve (Boolean!)

Whether or not the viewer can resolve this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUnresolve (Boolean!)

Whether or not the viewer can unresolve this thread.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewThreadConnection\n

\n

Review comment threads for a pull request review.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestReviewThreadEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestReviewThread])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewThreadEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestReviewThread)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestRevisionMarker\n

\n

Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

lastSeenCommit (Commit!)

The last commit the viewer has seen.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request to which the marker belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineConnection\n

\n

The connection type for PullRequestTimelineItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestTimelineItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestTimelineItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestTimelineItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineItemsConnection\n

\n

The connection type for PullRequestTimelineItems.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestTimelineItemsEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

filteredCount (Int!)

Identifies the count of items after applying before and after filters.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestTimelineItems])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageCount (Int!)

Identifies the count of items after applying before/after filters and first/last/skip slicing.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the timeline was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineItemsEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestTimelineItems)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Push\n

\n

A Git push.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

nextSha (GitObjectID)

The SHA after the push.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI!)

The permalink for this push.

\n\n\n\n\n\n\n\n\n\n\n\n

previousSha (GitObjectID)

The SHA before the push.

\n\n\n\n\n\n\n\n\n\n\n\n

pusher (User!)

The user who pushed.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository that was pushed to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PushAllowance\n

\n

A team, user or app who has the ability to push to a protected branch.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (PushAllowanceActor)

The actor that can push.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule associated with the allowed user or team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PushAllowanceConnection\n

\n

The connection type for PushAllowance.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PushAllowanceEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PushAllowance])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PushAllowanceEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PushAllowance)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RateLimit\n

\n

Represents the client's rate limit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cost (Int!)

The point cost for the current query counting against the rate limit.

\n\n\n\n\n\n\n\n\n\n\n\n

limit (Int!)

The maximum number of points the client is permitted to consume in a 60 minute window.

\n\n\n\n\n\n\n\n\n\n\n\n

nodeCount (Int!)

The maximum number of nodes this query may return.

\n\n\n\n\n\n\n\n\n\n\n\n

remaining (Int!)

The number of points remaining in the current rate limit window.

\n\n\n\n\n\n\n\n\n\n\n\n

resetAt (DateTime!)

The time at which the current rate limit window resets in UTC epoch seconds.

\n\n\n\n\n\n\n\n\n\n\n\n

used (Int!)

The number of points used in the current rate limit window.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactingUserConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReactingUserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactingUserEdge\n

\n

Represents a user that's made a reaction.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

reactedAt (DateTime!)

The moment when the user made the reaction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Reaction\n

\n

An emoji reaction to a particular piece of content.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

content (ReactionContent!)

Identifies the emoji reaction.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

reactable (Reactable!)

The reactable piece of content.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

Identifies the user who created this reaction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactionConnection\n

\n

A list of reactions that have been left on the subject.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReactionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Reaction])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasReacted (Boolean!)

Whether or not the authenticated user has left a reaction on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Reaction)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactionGroup\n

\n

A group of emoji reactions to a particular piece of content.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

content (ReactionContent!)

Identifies the emoji reaction.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime)

Identifies when the reaction was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (Reactable!)

The subject that was reacted to.

\n\n\n\n\n\n\n\n\n\n\n\n

users (ReactingUserConnection!)

Users who have reacted to the reaction subject with the emotion represented by this reaction group.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerHasReacted (Boolean!)

Whether or not the authenticated user has left a reaction on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReadyForReviewEvent\n

\n

Represents aready_for_reviewevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this ready for review event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this ready for review event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Ref\n

\n

Represents a Git reference.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

associatedPullRequests (PullRequestConnection!)

A list of pull requests with this ref as the head ref.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

branchProtectionRule (BranchProtectionRule)

Branch protection rules for this ref.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The ref name.

\n\n\n\n\n\n\n\n\n\n\n\n

prefix (String!)

The ref's prefix, such as refs/heads/ or refs/tags/.

\n\n\n\n\n\n\n\n\n\n\n\n

refUpdateRule (RefUpdateRule)

Branch protection rules that are viewable by non-admins.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository the ref belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

target (GitObject)

The object the ref points to. Returns null when object does not exist.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RefConnection\n

\n

The connection type for Ref.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RefEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Ref])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RefEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Ref)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RefUpdateRule\n

\n

A ref update rules for a viewer.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean!)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean!)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String!)

Identifies the protection rule pattern.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean!)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresSignatures (Boolean!)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanPush (Boolean!)

Can the viewer push to the branch.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReferencedEvent\n

\n

Represents areferencedevent on a given ReferencedSubject.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with thereferencedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

commitRepository (Repository!)

Identifies the repository associated with thereferencedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

isDirectReference (Boolean!)

Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (ReferencedSubject!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Release\n

\n

A release contains the content for a release.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (User)

The author of the release.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the release.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML)

The description of this release rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

isDraft (Boolean!)

Whether or not the release is a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

isLatest (Boolean!)

Whether or not the release is the latest releast.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrerelease (Boolean!)

Whether or not the release is a prerelease.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The title of the release.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies the date and time when the release was created.

\n\n\n\n\n\n\n\n\n\n\n\n

releaseAssets (ReleaseAssetConnection!)

List of releases assets which are dependent on this release.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

name (String)

\n

A list of names to filter the assets by.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository that the release belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

shortDescriptionHTML (HTML)

A description of the release, rendered to HTML without any links in it.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

limit (Int)

\n

How many characters to return.

\n

The default value is 200.

\n
\n\n
\n\n\n

tag (Ref)

The Git tag the release points to.

\n\n\n\n\n\n\n\n\n\n\n\n

tagCommit (Commit)

The tag commit for this release.

\n\n\n\n\n\n\n\n\n\n\n\n

tagName (String!)

The name of the release's Git tag.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseAsset\n

\n

A release asset contains the content for a release asset.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contentType (String!)

The asset's content-type.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

downloadCount (Int!)

The number of times this asset was downloaded.

\n\n\n\n\n\n\n\n\n\n\n\n

downloadUrl (URI!)

Identifies the URL where you can download the release asset via the browser.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Identifies the title of the release asset.

\n\n\n\n\n\n\n\n\n\n\n\n

release (Release)

Release that the asset is associated with.

\n\n\n\n\n\n\n\n\n\n\n\n

size (Int!)

The size (in bytes) of the asset.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

uploadedBy (User!)

The user that performed the upload.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

Identifies the URL of the release asset.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseAssetConnection\n

\n

The connection type for ReleaseAsset.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReleaseAssetEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ReleaseAsset])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseAssetEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ReleaseAsset)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseConnection\n

\n

The connection type for Release.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReleaseEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Release])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Release)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RemovedFromProjectEvent\n

\n

Represents aremoved_from_projectevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RenamedTitleEvent\n

\n

Represents arenamedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

currentTitle (String!)

Identifies the current title of the issue or pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

previousTitle (String!)

Identifies the previous title of the issue or pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (RenamedTitleSubject!)

Subject that was renamed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReopenedEvent\n

\n

Represents areopenedevent on any Closable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

closable (Closable!)

Object that was reopened.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoAccessAuditEntry\n

\n

Audit log entry for a repo.access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoAccessAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoAddMemberAuditEntry\n

\n

Audit log entry for a repo.add_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoAddMemberAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoAddTopicAuditEntry\n

\n

Audit log entry for a repo.add_topic event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topic (Topic)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicName (String)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoArchivedAuditEntry\n

\n

Audit log entry for a repo.archived event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoArchivedAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoChangeMergeSettingAuditEntry\n

\n

Audit log entry for a repo.change_merge_setting event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isEnabled (Boolean)

Whether the change was to enable (true) or disable (false) the merge type.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeType (RepoChangeMergeSettingAuditEntryMergeType)

The merge method affected by the change.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.disable_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.disable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableContributorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.disable_contributors_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableSockpuppetDisallowedAuditEntry\n

\n

Audit log entry for a repo.config.disable_sockpuppet_disallowed event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.enable_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.enable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableContributorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.enable_contributors_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableSockpuppetDisallowedAuditEntry\n

\n

Audit log entry for a repo.config.enable_sockpuppet_disallowed event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigLockAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.lock_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigUnlockAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.unlock_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoCreateAuditEntry\n

\n

Audit log entry for a repo.create event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

forkParentName (String)

The name of the parent repository for this forked repository.

\n\n\n\n\n\n\n\n\n\n\n\n

forkSourceName (String)

The name of the root repository for this network.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoCreateAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoDestroyAuditEntry\n

\n

Audit log entry for a repo.destroy event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoDestroyAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoRemoveMemberAuditEntry\n

\n

Audit log entry for a repo.remove_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoRemoveMemberAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoRemoveTopicAuditEntry\n

\n

Audit log entry for a repo.remove_topic event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topic (Topic)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicName (String)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Repository\n

\n

A repository contains the content for a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableUsers (UserConnection!)

A list of users that can be assigned to issues in this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters users with query on user name and login.

\n\n
\n\n
\n\n\n

branchProtectionRules (BranchProtectionRuleConnection!)

A list of branch protection rules for this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

codeOfConduct (CodeOfConduct)

Returns the code of conduct for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

collaborators (RepositoryCollaboratorConnection)

A list of collaborators associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliation (CollaboratorAffiliation)

\n

Collaborators affiliation level with a repository.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters users with query on user name and login.

\n\n
\n\n
\n\n\n

commitComments (CommitCommentConnection!)

A list of commit comments associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

contactLinks ([RepositoryContactLink!])

Returns a list of contact links associated to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

defaultBranchRef (Ref)

The Ref associated with the repository's default branch.

\n\n\n\n\n\n\n\n\n\n\n\n

deleteBranchOnMerge (Boolean!)

Whether or not branches are automatically deleted when merged in this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

dependencyGraphManifests (DependencyGraphManifestConnection)

A list of dependency manifests contained in the repository.

\n\n\n\n\n
\n

Preview notice

\n

dependencyGraphManifests is available under the Access to a repositories dependency graph preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

dependenciesAfter (String)

\n

Cursor to paginate dependencies.

\n\n
\n\n
\n

dependenciesFirst (Int)

\n

Number of dependencies to fetch.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

withDependencies (Boolean)

\n

Flag to scope to only manifests with dependencies.

\n\n
\n\n
\n\n\n

deployKeys (DeployKeyConnection!)

A list of deploy keys that are on this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

deployments (DeploymentConnection!)

Deployments associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

environments ([String!])

\n

Environments to list deployments for.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (DeploymentOrder)

\n

Ordering options for deployments returned from the connection.

\n\n
\n\n
\n\n\n

description (String)

The description of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML!)

The description of the repository rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

diskUsage (Int)

The number of kilobytes this repository occupies on disk.

\n\n\n\n\n\n\n\n\n\n\n\n

forkCount (Int!)

Returns how many forks there are of this repository in the whole network.

\n\n\n\n\n\n\n\n\n\n\n\n

forks (RepositoryConnection!)

A list of direct forked repositories.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

fundingLinks ([FundingLink!]!)

The funding links for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean!)

Indicates if the repository has issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasProjectsEnabled (Boolean!)

Indicates if the repository has the Projects feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean!)

Indicates if the repository has wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The repository's URL.

\n\n\n\n\n\n\n\n\n\n\n\n

interactionAbility (RepositoryInteractionAbility)

The interaction ability settings for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean!)

Indicates if the repository is unmaintained.

\n\n\n\n\n\n\n\n\n\n\n\n

isBlankIssuesEnabled (Boolean!)

Returns true if blank issue creation is allowed.

\n\n\n\n\n\n\n\n\n\n\n\n

isDisabled (Boolean!)

Returns whether or not this repository disabled.

\n\n\n\n\n\n\n\n\n\n\n\n

isEmpty (Boolean!)

Returns whether or not this repository is empty.

\n\n\n\n\n\n\n\n\n\n\n\n

isFork (Boolean!)

Identifies if the repository is a fork.

\n\n\n\n\n\n\n\n\n\n\n\n

isInOrganization (Boolean!)

Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.

\n\n\n\n\n\n\n\n\n\n\n\n

isLocked (Boolean!)

Indicates if the repository has been locked or not.

\n\n\n\n\n\n\n\n\n\n\n\n

isMirror (Boolean!)

Identifies if the repository is a mirror.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrivate (Boolean!)

Identifies if the repository is private.

\n\n\n\n\n\n\n\n\n\n\n\n

isSecurityPolicyEnabled (Boolean)

Returns true if this repository has a security policy.

\n\n\n\n\n\n\n\n\n\n\n\n

isTemplate (Boolean!)

Identifies if the repository is a template that can be used to generate new repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

isUserConfigurationRepository (Boolean!)

Is this repository a user configuration repository?.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue)

Returns a single issue from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the issue to be returned.

\n\n
\n\n
\n\n\n

issueOrPullRequest (IssueOrPullRequest)

Returns a single issue-like object from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the issue to be returned.

\n\n
\n\n
\n\n\n

issueTemplates ([IssueTemplate!])

Returns a list of issue templates associated to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

issues (IssueConnection!)

A list of issues that have been opened in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

label (Label)

Returns a single label by name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

Label name.

\n\n
\n\n
\n\n\n

labels (LabelConnection)

A list of labels associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n

query (String)

\n

If provided, searches labels by name and description.

\n\n
\n\n
\n\n\n

languages (LanguageConnection)

A list containing a breakdown of the language composition of the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LanguageOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

latestRelease (Release)

Get the latest release for the repository if one exists.

\n\n\n\n\n\n\n\n\n\n\n\n

licenseInfo (License)

The license associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (RepositoryLockReason)

The reason the repository has been locked.

\n\n\n\n\n\n\n\n\n\n\n\n

mentionableUsers (UserConnection!)

A list of Users that can be mentioned in the context of the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters users with query on user name and login.

\n\n
\n\n
\n\n\n

mergeCommitAllowed (Boolean!)

Whether or not PRs are merged with a merge commit on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (Milestone)

Returns a single milestone from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the milestone to be returned.

\n\n
\n\n
\n\n\n

milestones (MilestoneConnection)

A list of milestones associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (MilestoneOrder)

\n

Ordering options for milestones.

\n\n
\n\n
\n

query (String)

\n

Filters milestones with a query on the title.

\n\n
\n\n
\n

states ([MilestoneState!])

\n

Filter by the state of the milestones.

\n\n
\n\n
\n\n\n

mirrorUrl (URI)

The repository's original mirror URL.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

nameWithOwner (String!)

The repository's name with owner.

\n\n\n\n\n\n\n\n\n\n\n\n

object (GitObject)

A Git object in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

expression (String)

\n

A Git revision expression suitable for rev-parse.

\n\n
\n\n
\n

oid (GitObjectID)

\n

The Git object ID.

\n\n
\n\n
\n\n\n

openGraphImageUrl (URI!)

The image used to represent this repository in Open Graph data.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (RepositoryOwner!)

The User owner of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

packages (PackageConnection!)

A list of packages under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

names ([String])

\n

Find packages by their names.

\n\n
\n\n
\n

orderBy (PackageOrder)

\n

Ordering of the returned packages.

\n\n
\n\n
\n

packageType (PackageType)

\n

Filter registry package by type.

\n\n
\n\n
\n

repositoryId (ID)

\n

Find packages in a repository by ID.

\n\n
\n\n
\n\n\n

parent (Repository)

The repository parent, if this is a fork.

\n\n\n\n\n\n\n\n\n\n\n\n

pinnedIssues (PinnedIssueConnection)

A list of pinned issues for this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

primaryLanguage (Language)

The primary language of the repository's code.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Find project by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The project number to find.

\n\n
\n\n
\n\n\n

projects (ProjectConnection!)

A list of projects under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ProjectOrder)

\n

Ordering options for projects returned from the connection.

\n\n
\n\n
\n

search (String)

\n

Query to search projects by, currently only searching by name.

\n\n
\n\n
\n

states ([ProjectState!])

\n

A list of states to filter the projects by.

\n\n
\n\n
\n\n\n

projectsResourcePath (URI!)

The HTTP path listing the repository's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

projectsUrl (URI!)

The HTTP URL listing the repository's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

Returns a single pull request from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the pull request to be returned.

\n\n
\n\n
\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests that have been opened in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

pushedAt (DateTime)

Identifies when the repository was last pushed to.

\n\n\n\n\n\n\n\n\n\n\n\n

rebaseMergeAllowed (Boolean!)

Whether or not rebase-merging is enabled on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Fetch a given ref from the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

qualifiedName (String!)

\n

The ref to retrieve. Fully qualified matches are checked in order\n(refs/heads/master) before falling back onto checks for short name matches (master).

\n\n
\n\n
\n\n\n

refs (RefConnection)

Fetch a list of refs from the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

direction (OrderDirection)

\n

DEPRECATED: use orderBy. The ordering direction.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RefOrder)

\n

Ordering options for refs returned from the connection.

\n\n
\n\n
\n

query (String)

\n

Filters refs with query on name.

\n\n
\n\n
\n

refPrefix (String!)

\n

A ref name prefix like refs/heads/, refs/tags/, etc.

\n\n
\n\n
\n\n\n

release (Release)

Lookup a single release given various criteria.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

tagName (String!)

\n

The name of the Tag the Release was created from.

\n\n
\n\n
\n\n\n

releases (ReleaseConnection!)

List of releases which are dependent on this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReleaseOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

repositoryTopics (RepositoryTopicConnection!)

A list of applied repository-topic associations for this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

securityPolicyUrl (URI)

The security policy URL.

\n\n\n\n\n\n\n\n\n\n\n\n

shortDescriptionHTML (HTML!)

A description of the repository, rendered to HTML without any links in it.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

limit (Int)

\n

How many characters to return.

\n

The default value is 200.

\n
\n\n
\n\n\n

squashMergeAllowed (Boolean!)

Whether or not squash-merging is enabled on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

sshUrl (GitSSHRemote!)

The SSH URL to clone this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

submodules (SubmoduleConnection!)

Returns a list of all submodules in this repository parsed from the\n.gitmodules file as of the default branch's HEAD commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

tempCloneToken (String)

Temporary authentication token for cloning this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

templateRepository (Repository)

The repository from which this repository was generated, if any.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

usesCustomOpenGraphImage (Boolean!)

Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAdminister (Boolean!)

Indicates whether the viewer has admin permissions on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdateTopics (Boolean!)

Indicates whether the viewer can update the topics of this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDefaultCommitEmail (String)

The last commit email for the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDefaultMergeMethod (PullRequestMergeMethod!)

The last used merge method by the viewer or the default for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerPermission (RepositoryPermission)

The users permission level on the repository. Will return null if authenticated as an GitHub App.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerPossibleCommitEmails ([String!])

A list of emails this viewer can commit with.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerabilityAlerts (RepositoryVulnerabilityAlertConnection)

A list of vulnerability alerts that are on this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

watchers (UserConnection!)

A list of users watching the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryCollaboratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryCollaboratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryCollaboratorEdge\n

\n

Represents a user who is a collaborator of a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (RepositoryPermission!)

The permission the user has on the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

permissionSources ([PermissionSource!])

A list of sources for the user's access to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryConnection\n

\n

A list of repositories owned by the subject.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Repository])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalDiskUsage (Int!)

The total size in kilobytes of all repositories in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryContactLink\n

\n

A repository contact link.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

about (String!)

The contact link purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The contact link name.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The contact link URL.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Repository)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInteractionAbility\n

\n

Repository interaction limit that applies to this object.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

expiresAt (DateTime)

The time the currently active limit expires.

\n\n\n\n\n\n\n\n\n\n\n\n

limit (RepositoryInteractionLimit!)

The current limit that is enabled on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

origin (RepositoryInteractionLimitOrigin!)

The origin of the currently active interaction limit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInvitation\n

\n

An invitation for a user to be added to a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String)

The email address that received the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (User)

The user who received the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

inviter (User!)

The user who created the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI!)

The permalink for this repository invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (RepositoryPermission!)

The permission granted on this repository by this invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (RepositoryInfo)

The Repository the user is invited to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationConnection\n

\n

The connection type for RepositoryInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([RepositoryInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (RepositoryInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryTopic\n

\n

A repository-topic connects a repository to a topic.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

resourcePath (URI!)

The HTTP path for this repository-topic.

\n\n\n\n\n\n\n\n\n\n\n\n

topic (Topic!)

The topic.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this repository-topic.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryTopicConnection\n

\n

The connection type for RepositoryTopic.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryTopicEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([RepositoryTopic])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryTopicEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (RepositoryTopic)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVisibilityChangeDisableAuditEntry\n

\n

Audit log entry for a repository_visibility_change.disable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVisibilityChangeEnableAuditEntry\n

\n

Audit log entry for a repository_visibility_change.enable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVulnerabilityAlert\n

\n

A alert for a repository with an affected vulnerability.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

When was the alert created?.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissReason (String)

The reason the alert was dismissed.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissedAt (DateTime)

When was the alert dismissed?.

\n\n\n\n\n\n\n\n\n\n\n\n

dismisser (User)

The user who dismissed the alert.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The associated repository.

\n\n\n\n\n\n\n\n\n\n\n\n

securityAdvisory (SecurityAdvisory)

The associated security advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

securityVulnerability (SecurityVulnerability)

The associated security vulnerability.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableManifestFilename (String!)

The vulnerable manifest filename.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableManifestPath (String!)

The vulnerable manifest path.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableRequirements (String)

The vulnerable requirements.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVulnerabilityAlertConnection\n

\n

The connection type for RepositoryVulnerabilityAlert.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryVulnerabilityAlertEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([RepositoryVulnerabilityAlert])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVulnerabilityAlertEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (RepositoryVulnerabilityAlert)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RestrictedContribution\n

\n

Represents a private contribution a user made on GitHub.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissalAllowance\n

\n

A team or user who has the ability to dismiss a review on a protected branch.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (ReviewDismissalAllowanceActor)

The actor that can dismiss.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule associated with the allowed user or team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissalAllowanceConnection\n

\n

The connection type for ReviewDismissalAllowance.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReviewDismissalAllowanceEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ReviewDismissalAllowance])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissalAllowanceEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ReviewDismissalAllowance)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissedEvent\n

\n

Represents areview_dismissedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissalMessage (String)

Identifies the optional message associated with thereview_dismissedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissalMessageHTML (String)

Identifies the optional message associated with the event, rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

previousReviewState (PullRequestReviewState!)

Identifies the previous state of the review with thereview_dismissedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestCommit (PullRequestCommit)

Identifies the commit which caused the review to become stale.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this review dismissed event.

\n\n\n\n\n\n\n\n\n\n\n\n

review (PullRequestReview)

Identifies the review associated with thereview_dismissedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this review dismissed event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequest\n

\n

A request for a user to review a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

asCodeOwner (Boolean!)

Whether this request was created for a code owner.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

Identifies the pull request associated with this review request.

\n\n\n\n\n\n\n\n\n\n\n\n

requestedReviewer (RequestedReviewer)

The reviewer that is requested.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestConnection\n

\n

The connection type for ReviewRequest.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReviewRequestEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ReviewRequest])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ReviewRequest)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestRemovedEvent\n

\n

Represents anreview_request_removedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

requestedReviewer (RequestedReviewer)

Identifies the reviewer whose review request was removed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestedEvent\n

\n

Represents anreview_requestedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

requestedReviewer (RequestedReviewer)

Identifies the reviewer whose review was requested.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewStatusHovercardContext\n

\n

A hovercard context with a message describing the current code review state of the pull\nrequest.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDecision (PullRequestReviewDecision)

The current status of the pull request with respect to code review.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SavedReply\n

\n

A Saved Reply is text a user can use to reply quickly.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the saved reply.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The saved reply body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the saved reply.

\n\n\n\n\n\n\n\n\n\n\n\n

user (Actor)

The user that saved this reply.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SavedReplyConnection\n

\n

The connection type for SavedReply.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SavedReplyEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SavedReply])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SavedReplyEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SavedReply)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SearchResultItemConnection\n

\n

A list of results that matched against a search query.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

codeCount (Int!)

The number of pieces of code that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

edges ([SearchResultItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

issueCount (Int!)

The number of issues that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SearchResultItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryCount (Int!)

The number of repositories that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

userCount (Int!)

The number of users that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

wikiCount (Int!)

The number of wiki pages that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SearchResultItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SearchResultItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

textMatches ([TextMatch])

Text matches on the result found.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisory\n

\n

A GitHub Security Advisory.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cvss (CVSS!)

The CVSS associated with this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

cwes (CWEConnection!)

CWEs associated with this Advisory.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String!)

This is a long plaintext description of the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

ghsaId (String!)

The GitHub Security Advisory ID.

\n\n\n\n\n\n\n\n\n\n\n\n

identifiers ([SecurityAdvisoryIdentifier!]!)

A list of identifiers for this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

notificationsPermalink (URI)

The permalink for the advisory's dependabot alerts page.

\n\n\n\n\n\n\n\n\n\n\n\n

origin (String!)

The organization that originated the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI)

The permalink for the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime!)

When the advisory was published.

\n\n\n\n\n\n\n\n\n\n\n\n

references ([SecurityAdvisoryReference!]!)

A list of references for this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

severity (SecurityAdvisorySeverity!)

The severity of the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String!)

A short plaintext summary of the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

When the advisory was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerabilities (SecurityVulnerabilityConnection!)

Vulnerabilities associated with this Advisory.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

ecosystem (SecurityAdvisoryEcosystem)

\n

An ecosystem to filter vulnerabilities by.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SecurityVulnerabilityOrder)

\n

Ordering options for the returned topics.

\n\n
\n\n
\n

package (String)

\n

A package name to filter vulnerabilities by.

\n\n
\n\n
\n

severities ([SecurityAdvisorySeverity!])

\n

A list of severities to filter vulnerabilities by.

\n\n
\n\n
\n\n\n

withdrawnAt (DateTime)

When the advisory was withdrawn, if it has been withdrawn.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryConnection\n

\n

The connection type for SecurityAdvisory.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SecurityAdvisoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SecurityAdvisory])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SecurityAdvisory)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryIdentifier\n

\n

A GitHub Security Advisory Identifier.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

type (String!)

The identifier type, e.g. GHSA, CVE.

\n\n\n\n\n\n\n\n\n\n\n\n

value (String!)

The identifier.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryPackage\n

\n

An individual package.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

ecosystem (SecurityAdvisoryEcosystem!)

The ecosystem the package belongs to, e.g. RUBYGEMS, NPM.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The package name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryPackageVersion\n

\n

An individual package version.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

identifier (String!)

The package name or version.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryReference\n

\n

A GitHub Security Advisory Reference.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

url (URI!)

A publicly accessible reference.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityVulnerability\n

\n

An individual vulnerability within an Advisory.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

advisory (SecurityAdvisory!)

The Advisory associated with this Vulnerability.

\n\n\n\n\n\n\n\n\n\n\n\n

firstPatchedVersion (SecurityAdvisoryPackageVersion)

The first version containing a fix for the vulnerability.

\n\n\n\n\n\n\n\n\n\n\n\n

package (SecurityAdvisoryPackage!)

A description of the vulnerable package.

\n\n\n\n\n\n\n\n\n\n\n\n

severity (SecurityAdvisorySeverity!)

The severity of the vulnerability within this package.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

When the vulnerability was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableVersionRange (String!)

A string that describes the vulnerable package versions.\nThis string follows a basic syntax with a few forms.

\n
    \n
  • = 0.2.0 denotes a single vulnerable version.
    • \n
  • <= 1.0.8 denotes a version range up to and including the specified version
    • \n
  • < 0.1.11 denotes a version range up to, but excluding, the specified version
    • \n
  • >= 4.3.0, < 4.3.5 denotes a version range with a known minimum and maximum version.
    • \n
  • >= 0.0.1 denotes a version range with a known minimum, but no known maximum.
    • \n

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityVulnerabilityConnection\n

\n

The connection type for SecurityVulnerability.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SecurityVulnerabilityEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SecurityVulnerability])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityVulnerabilityEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SecurityVulnerability)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SmimeSignature\n

\n

Represents an S/MIME signature on a Commit or Tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String!)

Email used to sign this object.

\n\n\n\n\n\n\n\n\n\n\n\n

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (String!)

ASCII-armored signature header from object.

\n\n\n\n\n\n\n\n\n\n\n\n

signer (User)

GitHub user corresponding to the email signing this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

\n\n\n\n\n\n\n\n\n\n\n\n

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorableItemConnection\n

\n

The connection type for SponsorableItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SponsorableItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SponsorableItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorableItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SponsorableItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorsGoal\n

\n

A goal associated with a GitHub Sponsors listing, representing a target the sponsored maintainer would like to attain.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String)

A description of the goal from the maintainer.

\n\n\n\n\n\n\n\n\n\n\n\n

kind (SponsorsGoalKind!)

What the objective of this goal is.

\n\n\n\n\n\n\n\n\n\n\n\n

percentComplete (Int!)

The percentage representing how complete this goal is, between 0-100.

\n\n\n\n\n\n\n\n\n\n\n\n

targetValue (Int!)

What the goal amount is. Represents a dollar amount for monthly sponsorship\namount goals. Represents a count of unique sponsors for total sponsors count goals.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

A brief summary of the kind and target value of this goal.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorsListing\n

\n

A GitHub Sponsors listing.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

activeGoal (SponsorsGoal)

The current goal the maintainer is trying to reach with GitHub Sponsors, if any.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

fullDescription (String!)

The full description of the listing.

\n\n\n\n\n\n\n\n\n\n\n\n

fullDescriptionHTML (HTML!)

The full description of the listing rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The listing's full name.

\n\n\n\n\n\n\n\n\n\n\n\n

shortDescription (String!)

The short description of the listing.

\n\n\n\n\n\n\n\n\n\n\n\n

slug (String!)

The short name of the listing.

\n\n\n\n\n\n\n\n\n\n\n\n

tiers (SponsorsTierConnection)

The published tiers for this GitHub Sponsors listing.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorsTierOrder)

\n

Ordering options for Sponsors tiers returned from the connection.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorsTier\n

\n

A GitHub Sponsors tier associated with a GitHub Sponsors listing.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

adminInfo (SponsorsTierAdminInfo)

SponsorsTier information only visible to users that can administer the associated Sponsors listing.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String!)

The description of the tier.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML!)

The tier description rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

monthlyPriceInCents (Int!)

How much this tier costs per month in cents.

\n\n\n\n\n\n\n\n\n\n\n\n

monthlyPriceInDollars (Int!)

How much this tier costs per month in dollars.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the tier.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorsListing (SponsorsListing!)

The sponsors listing that this tier belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorsTierAdminInfo\n

\n

SponsorsTier information only visible to users that can administer the associated Sponsors listing.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

sponsorships (SponsorshipConnection!)

The sponsorships associated with this tier.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includePrivate (Boolean)

\n

Whether or not to include private sponsorships in the result set.

\n

The default value is false.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorsTierConnection\n

\n

The connection type for SponsorsTier.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SponsorsTierEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SponsorsTier])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorsTierEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SponsorsTier)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Sponsorship\n

\n

A sponsorship relationship between a sponsor and a maintainer.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainer (User!)

The entity that is being sponsored.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

maintainer is deprecated.

Sponsorship.maintainer will be removed. Use Sponsorship.sponsorable instead. Removal on 2020-04-01 UTC.

\n
\n\n\n\n\n\n\n

privacyLevel (SponsorshipPrivacy!)

The privacy level for this sponsorship.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsor (User)

The user that is sponsoring. Returns null if the sponsorship is private or if sponsor is not a user.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

sponsor is deprecated.

Sponsorship.sponsor will be removed. Use Sponsorship.sponsorEntity instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n\n

sponsorEntity (Sponsor)

The user or organization that is sponsoring, if you have permission to view them.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorable (Sponsorable!)

The entity that is being sponsored.

\n\n\n\n\n\n\n\n\n\n\n\n

tier (SponsorsTier)

The associated sponsorship tier.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorshipConnection\n

\n

The connection type for Sponsorship.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SponsorshipEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Sponsorship])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorshipEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Sponsorship)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StargazerConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([StargazerEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StargazerEdge\n

\n

Represents a user that's starred a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

starredAt (DateTime!)

Identifies when the item was starred.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StarredRepositoryConnection\n

\n

The connection type for Repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([StarredRepositoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

isOverLimit (Boolean!)

Is the list of stars for this user truncated? This is true for users that have many stars.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Repository])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StarredRepositoryEdge\n

\n

Represents a starred repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

starredAt (DateTime!)

Identifies when the item was starred.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Status\n

\n

Represents a commit status.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

combinedContexts (StatusCheckRollupContextConnection!)

A list of status contexts and check runs for this commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit)

The commit this status is attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

context (StatusContext)

Looks up an individual status context by context name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

The context name.

\n\n
\n\n
\n\n\n

contexts ([StatusContext!]!)

The individual status contexts for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (StatusState!)

The combined commit status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusCheckRollup\n

\n

Represents the rollup for both the check runs and status for a commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commit (Commit)

The commit the status and check runs are attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

contexts (StatusCheckRollupContextConnection!)

A list of status contexts and check runs for this commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

state (StatusState!)

The combined status for the commit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusCheckRollupContextConnection\n

\n

The connection type for StatusCheckRollupContext.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([StatusCheckRollupContextEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([StatusCheckRollupContext])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusCheckRollupContextEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (StatusCheckRollupContext)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusContext\n

\n

Represents an individual commit status context.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI)

The avatar of the OAuth application or the user that created the status.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n

The default value is 40.

\n
\n\n
\n\n\n

commit (Commit)

This commit this status context is attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

context (String!)

The name of this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

The actor who created this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description for this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

state (StatusState!)

The state of this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

targetUrl (URI)

The URL for this status context.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Submodule\n

\n

A pointer to a repository at a specific revision embedded inside another repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branch (String)

The branch of the upstream submodule for tracking updates.

\n\n\n\n\n\n\n\n\n\n\n\n

gitUrl (URI!)

The git URL of the submodule repository.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the submodule in .gitmodules.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path in the superproject that this submodule is located in.

\n\n\n\n\n\n\n\n\n\n\n\n

subprojectCommitOid (GitObjectID)

The commit revision of the subproject repository being tracked by the submodule.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SubmoduleConnection\n

\n

The connection type for Submodule.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SubmoduleEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Submodule])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SubmoduleEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Submodule)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SubscribedEvent\n

\n

Represents asubscribedevent on a given Subscribable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribable (Subscribable!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SuggestedReviewer\n

\n

A suggestion to review a pull request based on a user's commit history and review comments.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isAuthor (Boolean!)

Is this suggestion based on past commits?.

\n\n\n\n\n\n\n\n\n\n\n\n

isCommenter (Boolean!)

Is this suggestion based on past review comments?.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewer (User!)

Identifies the user suggested to review the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Tag\n

\n

Represents a Git tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

The Git tag message.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The Git tag name.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the Git object belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

tagger (GitActor)

Details about the tag author.

\n\n\n\n\n\n\n\n\n\n\n\n

target (GitObject!)

The Git object the tag points to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Team\n

\n

A team of users in an organization.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

ancestors (TeamConnection!)

A list of teams that are ancestors of this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

avatarUrl (URI)

A URL pointing to the team's avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size in pixels of the resulting square image.

\n

The default value is 400.

\n
\n\n
\n\n\n

childTeams (TeamConnection!)

List of child teams belonging to this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

immediateOnly (Boolean)

\n

Whether to list immediate child teams or all descendant child teams.

\n

The default value is true.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamOrder)

\n

Order for connection.

\n\n
\n\n
\n

userLogins ([String!])

\n

User logins to filter by.

\n\n
\n\n
\n\n\n

combinedSlug (String!)

The slug corresponding to the organization and team.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

discussion (TeamDiscussion)

Find a team discussion by its number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The sequence number of the discussion to find.

\n\n
\n\n
\n\n\n

discussions (TeamDiscussionConnection!)

A list of team discussions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isPinned (Boolean)

\n

If provided, filters discussions according to whether or not they are pinned.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamDiscussionOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

discussionsResourcePath (URI!)

The HTTP path for team discussions.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionsUrl (URI!)

The HTTP URL for team discussions.

\n\n\n\n\n\n\n\n\n\n\n\n

editTeamResourcePath (URI!)

The HTTP path for editing this team.

\n\n\n\n\n\n\n\n\n\n\n\n

editTeamUrl (URI!)

The HTTP URL for editing this team.

\n\n\n\n\n\n\n\n\n\n\n\n

invitations (OrganizationInvitationConnection)

A list of pending invitations for users to this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

memberStatuses (UserStatusConnection!)

Get the status messages members of this entity have set that are either public or visible only to the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (UserStatusOrder)

\n

Ordering options for user statuses returned from the connection.

\n\n
\n\n
\n\n\n

members (TeamMemberConnection!)

A list of users who are members of this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

membership (TeamMembershipType)

\n

Filter by membership type.

\n

The default value is ALL.

\n
\n\n
\n

orderBy (TeamMemberOrder)

\n

Order for the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (TeamMemberRole)

\n

Filter by team member role.

\n\n
\n\n
\n\n\n

membersResourcePath (URI!)

The HTTP path for the team' members.

\n\n\n\n\n\n\n\n\n\n\n\n

membersUrl (URI!)

The HTTP URL for the team' members.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamResourcePath (URI!)

The HTTP path creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamUrl (URI!)

The HTTP URL creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization!)

The organization that owns this team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeam (Team)

The parent team of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

privacy (TeamPrivacy!)

The level of privacy the team has.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (TeamRepositoryConnection!)

A list of repositories this team has access to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamRepositoryOrder)

\n

Order for the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

repositoriesResourcePath (URI!)

The HTTP path for this team's repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoriesUrl (URI!)

The HTTP URL for this team's repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewRequestDelegationAlgorithm (TeamReviewAssignmentAlgorithm)

What algorithm is used for review assignment for this team.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationAlgorithm is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

reviewRequestDelegationEnabled (Boolean!)

True if review assignment is enabled for this team.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationEnabled is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

reviewRequestDelegationMemberCount (Int)

How many team members are required for review assignment for this team.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationMemberCount is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

reviewRequestDelegationNotifyTeam (Boolean!)

When assigning team members via delegation, whether the entire team should be notified as well.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationNotifyTeam is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

slug (String!)

The slug corresponding to the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsResourcePath (URI!)

The HTTP path for this team's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsUrl (URI!)

The HTTP URL for this team's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAdminister (Boolean!)

Team is adminable by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamAddMemberAuditEntry\n

\n

Audit log entry for a team.add_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamAddRepositoryAuditEntry\n

\n

Audit log entry for a team.add_repository event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamChangeParentTeamAuditEntry\n

\n

Audit log entry for a team.change_parent_team event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeam (Team)

The new parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamName (String)

The name of the new parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamNameWas (String)

The name of the former parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamResourcePath (URI)

The HTTP path for the parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamUrl (URI)

The HTTP URL for the parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamWas (Team)

The former parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamWasResourcePath (URI)

The HTTP path for the previous parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamWasUrl (URI)

The HTTP URL for the previous parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamConnection\n

\n

The connection type for Team.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Team])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussion\n

\n

A team discussion.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the discussion's team.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String!)

Identifies the discussion body hash.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (TeamDiscussionCommentConnection!)

A list of comments on this discussion.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

fromComment (Int)

\n

When provided, filters the connection such that results begin with the comment with this number.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamDiscussionCommentOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

commentsResourcePath (URI!)

The HTTP path for discussion comments.

\n\n\n\n\n\n\n\n\n\n\n\n

commentsUrl (URI!)

The HTTP URL for discussion comments.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isPinned (Boolean!)

Whether or not the discussion is pinned.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrivate (Boolean!)

Whether or not the discussion is only visible to team members and org admins.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the discussion within its team.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team!)

The team that defines the context of this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanPin (Boolean!)

Whether or not the current viewer can pin this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionComment\n

\n

A comment on a team discussion.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the comment's team.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String!)

The current version of the body content.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

discussion (TeamDiscussion!)

The discussion this comment is about.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the comment number.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentConnection\n

\n

The connection type for TeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamDiscussionCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([TeamDiscussionComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (TeamDiscussionComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionConnection\n

\n

The connection type for TeamDiscussion.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamDiscussionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([TeamDiscussion])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (TeamDiscussion)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Team)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamMemberConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamMemberEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamMemberEdge\n

\n

Represents a user who is a member of a team.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

memberAccessResourcePath (URI!)

The HTTP path to the organization's member access page.

\n\n\n\n\n\n\n\n\n\n\n\n

memberAccessUrl (URI!)

The HTTP URL to the organization's member access page.

\n\n\n\n\n\n\n\n\n\n\n\n

role (TeamMemberRole!)

The role the member has on the team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRemoveMemberAuditEntry\n

\n

Audit log entry for a team.remove_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRemoveRepositoryAuditEntry\n

\n

Audit log entry for a team.remove_repository event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRepositoryConnection\n

\n

The connection type for Repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamRepositoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Repository])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRepositoryEdge\n

\n

Represents a team repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (RepositoryPermission!)

The permission level the team has on the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TextMatch\n

\n

A text match within a search result.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

fragment (String!)

The specific text fragment within the property matched on.

\n\n\n\n\n\n\n\n\n\n\n\n

highlights ([TextMatchHighlight!]!)

Highlights within the matched fragment.

\n\n\n\n\n\n\n\n\n\n\n\n

property (String!)

The property matched on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TextMatchHighlight\n

\n

Represents a single highlight in a search result match.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

beginIndice (Int!)

The indice in the fragment where the matched text begins.

\n\n\n\n\n\n\n\n\n\n\n\n

endIndice (Int!)

The indice in the fragment where the matched text ends.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String!)

The text matched.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Topic\n

\n

A topic aggregates entities that are related to a subject.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

name (String!)

The topic's name.

\n\n\n\n\n\n\n\n\n\n\n\n

relatedTopics ([Topic!]!)

A list of related topics, including aliases of this topic, sorted with the most relevant\nfirst. Returns up to 10 Topics.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

first (Int)

\n

How many topics to return.

\n

The default value is 3.

\n
\n\n
\n\n\n

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TransferredEvent\n

\n

Represents atransferredevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

fromRepository (Repository)

The repository this came from.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Tree\n

\n

Represents a Git tree.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

entries ([TreeEntry!])

A list of tree entries.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the Git object belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TreeEntry\n

\n

Represents a Git tree entry.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

extension (String)

The extension of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

isGenerated (Boolean!)

Whether or not this tree entry is generated.

\n\n\n\n\n\n\n\n\n\n\n\n

mode (Int!)

Entry file mode.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Entry file name.

\n\n\n\n\n\n\n\n\n\n\n\n

object (GitObject)

Entry file object.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

Entry file Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The full path of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the tree entry belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

submodule (Submodule)

If the TreeEntry is for a directory occupied by a submodule project, this returns the corresponding submodule.

\n\n\n\n\n\n\n\n\n\n\n\n

type (String!)

Entry file type.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnassignedEvent\n

\n

Represents anunassignedevent on any assignable object.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignable (Assignable!)

Identifies the assignable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignee (Assignee)

Identifies the user or mannequin that was unassigned.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

Identifies the subject (user) who was unassigned.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

user is deprecated.

Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnknownSignature\n

\n

Represents an unknown signature on a Commit or Tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String!)

Email used to sign this object.

\n\n\n\n\n\n\n\n\n\n\n\n

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (String!)

ASCII-armored signature header from object.

\n\n\n\n\n\n\n\n\n\n\n\n

signer (User)

GitHub user corresponding to the email signing this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

\n\n\n\n\n\n\n\n\n\n\n\n

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnlabeledEvent\n

\n

Represents anunlabeledevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

label (Label!)

Identifies the label associated with theunlabeledevent.

\n\n\n\n\n\n\n\n\n\n\n\n

labelable (Labelable!)

Identifies the Labelable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnlockedEvent\n

\n

Represents anunlockedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

lockable (Lockable!)

Object that was unlocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnmarkedAsDuplicateEvent\n

\n

Represents anunmarked_as_duplicateevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

canonical (IssueOrPullRequest)

The authoritative issue or pull request which has been duplicated by another.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicate (IssueOrPullRequest)

The issue or pull request which has been marked as a duplicate of another.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Canonical and duplicate belong to different repositories.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnpinnedEvent\n

\n

Represents anunpinnedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnsubscribedEvent\n

\n

Represents anunsubscribedevent on a given Subscribable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribable (Subscribable!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n User\n

\n

A user is an individual's account on GitHub that owns repositories and can make new content.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

anyPinnableItems (Boolean!)

Determine if this repository owner has any items that can be pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

type (PinnableItemType)

\n

Filter to only a particular kind of pinnable item.

\n\n
\n\n
\n\n\n

avatarUrl (URI!)

A URL pointing to the user's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

bio (String)

The user's public profile bio.

\n\n\n\n\n\n\n\n\n\n\n\n

bioHTML (HTML!)

The user's public profile bio as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

commitComments (CommitCommentConnection!)

A list of commit comments made by this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

company (String)

The user's public profile company.

\n\n\n\n\n\n\n\n\n\n\n\n

companyHTML (HTML!)

The user's public profile company as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionsCollection (ContributionsCollection!)

The collection of contributions this user has made to different repositories.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

from (DateTime)

\n

Only contributions made at this time or later will be counted. If omitted, defaults to a year ago.

\n\n
\n\n
\n

organizationID (ID)

\n

The ID of the organization used to filter contributions.

\n\n
\n\n
\n

to (DateTime)

\n

Only contributions made before and up to and including this time will be\ncounted. If omitted, defaults to the current time.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String!)

The user's publicly visible profile email.

\n\n\n\n\n\n\n\n\n\n\n\n

followers (FollowerConnection!)

A list of users the given user is followed by.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

following (FollowingConnection!)

A list of users the given user is following.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

gist (Gist)

Find gist by repo name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

The gist name to find.

\n\n
\n\n
\n\n\n

gistComments (GistCommentConnection!)

A list of gist comments made by this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

gists (GistConnection!)

A list of the Gists the user has created.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (GistOrder)

\n

Ordering options for gists returned from the connection.

\n\n
\n\n
\n

privacy (GistPrivacy)

\n

Filters Gists according to privacy.

\n\n
\n\n
\n\n\n

hasSponsorsListing (Boolean!)

True if this user/organization has a GitHub Sponsors listing.

\n\n\n\n\n\n\n\n\n\n\n\n

hovercard (Hovercard!)

The hovercard information for this user in a given context.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

primarySubjectId (ID)

\n

The ID of the subject to get the hovercard in the context of.

\n\n
\n\n
\n\n\n

interactionAbility (RepositoryInteractionAbility)

The interaction ability settings for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

isBountyHunter (Boolean!)

Whether or not this user is a participant in the GitHub Security Bug Bounty.

\n\n\n\n\n\n\n\n\n\n\n\n

isCampusExpert (Boolean!)

Whether or not this user is a participant in the GitHub Campus Experts Program.

\n\n\n\n\n\n\n\n\n\n\n\n

isDeveloperProgramMember (Boolean!)

Whether or not this user is a GitHub Developer Program member.

\n\n\n\n\n\n\n\n\n\n\n\n

isEmployee (Boolean!)

Whether or not this user is a GitHub employee.

\n\n\n\n\n\n\n\n\n\n\n\n

isGitHubStar (Boolean!)

Whether or not this user is a member of the GitHub Stars Program.

\n\n\n\n\n\n\n\n\n\n\n\n

isHireable (Boolean!)

Whether or not the user has marked themselves as for hire.

\n\n\n\n\n\n\n\n\n\n\n\n

isSiteAdmin (Boolean!)

Whether or not this user is a site administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

isSponsoredBy (Boolean!)

Check if the given account is sponsoring this user/organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

accountLogin (String!)

\n

The target account's login.

\n\n
\n\n
\n\n\n

isSponsoringViewer (Boolean!)

True if the viewer is sponsored by this user/organization.

\n\n\n\n\n\n\n\n\n\n\n\n

isViewer (Boolean!)

Whether or not this user is the viewing user.

\n\n\n\n\n\n\n\n\n\n\n\n

issueComments (IssueCommentConnection!)

A list of issue comments made by this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueCommentOrder)

\n

Ordering options for issue comments returned from the connection.

\n\n
\n\n
\n\n\n

issues (IssueConnection!)

A list of issues associated with this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

itemShowcase (ProfileItemShowcase!)

Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The user's public profile location.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The username used to login.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The user's public profile name.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

Find an organization by its login that the user belongs to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

login (String!)

\n

The login of the organization to find.

\n\n
\n\n
\n\n\n

organizationVerifiedDomainEmails ([String!]!)

Verified email addresses that match verified domains for a specified organization the user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

login (String!)

\n

The login of the organization to match verified domains from.

\n\n
\n\n
\n\n\n

organizations (OrganizationConnection!)

A list of organizations the user belongs to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

packages (PackageConnection!)

A list of packages under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

names ([String])

\n

Find packages by their names.

\n\n
\n\n
\n

orderBy (PackageOrder)

\n

Ordering of the returned packages.

\n\n
\n\n
\n

packageType (PackageType)

\n

Filter registry package by type.

\n\n
\n\n
\n

repositoryId (ID)

\n

Find packages in a repository by ID.

\n\n
\n\n
\n\n\n

pinnableItems (PinnableItemConnection!)

A list of repositories and gists this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinnable items that are returned.

\n\n
\n\n
\n\n\n

pinnedItems (PinnableItemConnection!)

A list of repositories and gists this profile owner has pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinned items that are returned.

\n\n
\n\n
\n\n\n

pinnedItemsRemaining (Int!)

Returns how many more items this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Find project by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The project number to find.

\n\n
\n\n
\n\n\n

projects (ProjectConnection!)

A list of projects under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ProjectOrder)

\n

Ordering options for projects returned from the connection.

\n\n
\n\n
\n

search (String)

\n

Query to search projects by, currently only searching by name.

\n\n
\n\n
\n

states ([ProjectState!])

\n

A list of states to filter the projects by.

\n\n
\n\n
\n\n\n

projectsResourcePath (URI!)

The HTTP path listing user's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

projectsUrl (URI!)

The HTTP URL listing user's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

publicKeys (PublicKeyConnection!)

A list of public keys associated with this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests associated with this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

repositories (RepositoryConnection!)

A list of repositories that the user owns.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isFork (Boolean)

\n

If non-null, filters repositories according to whether they are forks of another repository.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

repositoriesContributedTo (RepositoryConnection!)

A list of repositories that the user recently contributed to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

contributionTypes ([RepositoryContributionType])

\n

If non-null, include only the specified types of contributions. The\nGitHub.com UI uses [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY].

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includeUserRepositories (Boolean)

\n

If true, include user repositories.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

repository (Repository)

Find Repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

Name of Repository to find.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

savedReplies (SavedReplyConnection)

Replies this user has saved.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SavedReplyOrder)

\n

The field to order saved replies by.

\n\n
\n\n
\n\n\n

sponsorsListing (SponsorsListing)

The GitHub Sponsors listing for this user or organization.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorshipForViewerAsSponsor (Sponsorship)

The viewer's sponsorship of this entity.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorshipsAsMaintainer (SponsorshipConnection!)

This object's sponsorships as the maintainer.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includePrivate (Boolean)

\n

Whether or not to include private sponsorships in the result set.

\n

The default value is false.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

sponsorshipsAsSponsor (SponsorshipConnection!)

This object's sponsorships as the sponsor.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

starredRepositories (StarredRepositoryConnection!)

Repositories the user has starred.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n

ownedByViewer (Boolean)

\n

Filters starred repositories to only return repositories owned by the viewer.

\n\n
\n\n
\n\n\n

status (UserStatus)

The user's description of what they're currently doing.

\n\n\n\n\n\n\n\n\n\n\n\n

topRepositories (RepositoryConnection!)

Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder!)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

since (DateTime)

\n

How far back in time to fetch contributed repositories.

\n\n
\n\n
\n\n\n

twitterUsername (String)

The user's Twitter username.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanChangePinnedItems (Boolean!)

Can the viewer pin repositories and gists to the profile?.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanFollow (Boolean!)

Whether or not the viewer is able to follow the user.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSponsor (Boolean!)

Whether or not the viewer is able to sponsor this user/organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerIsFollowing (Boolean!)

Whether or not this user is followed by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerIsSponsoring (Boolean!)

True if the viewer is sponsoring this user/organization.

\n\n\n\n\n\n\n\n\n\n\n\n

watching (RepositoryConnection!)

A list of repositories the given user is watching.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Affiliation options for repositories returned from the connection. If none\nspecified, the results will include repositories for which the current\nviewer is an owner or collaborator, or member.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

websiteUrl (URI)

A URL pointing to the user's public website/blog.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserBlockedEvent\n

\n

Represents auser_blockedevent on a given user.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

blockDuration (UserBlockDuration!)

Number of days that the user was blocked for.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (User)

The user who was blocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserContentEdit\n

\n

An edit on user content.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

deletedAt (DateTime)

Identifies the date and time when the object was deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

deletedBy (Actor)

The actor who deleted this content.

\n\n\n\n\n\n\n\n\n\n\n\n

diff (String)

A summary of the changes for this edit.

\n\n\n\n\n\n\n\n\n\n\n\n

editedAt (DateTime!)

When this content was edited.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited this content.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserContentEditConnection\n

\n

A list of edits to content.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserContentEditEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([UserContentEdit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserContentEditEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (UserContentEdit)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserEdge\n

\n

Represents a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserEmailMetadata\n

\n

Email attributes from External Identity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

primary (Boolean)

Boolean to identify primary emails.

\n\n\n\n\n\n\n\n\n\n\n\n

type (String)

Type of email.

\n\n\n\n\n\n\n\n\n\n\n\n

value (String!)

Email id.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserStatus\n

\n

The user's description of what they're currently doing.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

emoji (String)

An emoji summarizing the user's status.

\n\n\n\n\n\n\n\n\n\n\n\n

emojiHTML (HTML)

The status emoji as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

expiresAt (DateTime)

If set, the status will not be shown after this date.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

ID of the object.

\n\n\n\n\n\n\n\n\n\n\n\n

indicatesLimitedAvailability (Boolean!)

Whether this status indicates the user is not fully available on GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

A brief message describing what the user is doing.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The organization whose members can see this status. If null, this status is publicly visible.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who has this status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserStatusConnection\n

\n

The connection type for UserStatus.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserStatusEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([UserStatus])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserStatusEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (UserStatus)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n VerifiableDomain\n

\n

A domain that can be verified for an organization or an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

dnsHostName (URI)

The DNS host name that should be used for verification.

\n\n\n\n\n\n\n\n\n\n\n\n

domain (URI!)

The unicode encoded domain.

\n\n\n\n\n\n\n\n\n\n\n\n

hasFoundHostName (Boolean!)

Whether a TXT record for verification with the expected host name was found.

\n\n\n\n\n\n\n\n\n\n\n\n

hasFoundVerificationToken (Boolean!)

Whether a TXT record for verification with the expected verification token was found.

\n\n\n\n\n\n\n\n\n\n\n\n

isRequiredForPolicyEnforcement (Boolean!)

Whether this domain is required to exist for an organization or enterprise policy to be enforced.

\n\n\n\n\n\n\n\n\n\n\n\n

isVerified (Boolean!)

Whether or not the domain is verified.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (VerifiableDomainOwner!)

The owner of the domain.

\n\n\n\n\n\n\n\n\n\n\n\n

punycodeEncodedDomain (URI!)

The punycode encoded domain.

\n\n\n\n\n\n\n\n\n\n\n\n

tokenExpirationTime (DateTime)

The time that the current verification token will expire.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

verificationToken (String)

The current verification token for the domain.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n VerifiableDomainConnection\n

\n

The connection type for VerifiableDomain.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([VerifiableDomainEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([VerifiableDomain])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n VerifiableDomainEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (VerifiableDomain)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ViewerHovercardContext\n

\n

A hovercard context with a message describing how the viewer is related.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

viewer (User!)

Identifies the user who is related to this context.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n", "miniToc": [ { "contents": "\n ActorLocation\n ", @@ -10975,7 +10975,7 @@ ] }, "ghae": { - "html": "
\n
\n

\n ActorLocation\n

\n

Location information for an actor.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

city (String)

City.

\n\n\n\n\n\n\n\n\n\n\n\n

country (String)

Country name.

\n\n\n\n\n\n\n\n\n\n\n\n

countryCode (String)

Country code.

\n\n\n\n\n\n\n\n\n\n\n\n

region (String)

Region name.

\n\n\n\n\n\n\n\n\n\n\n\n

regionCode (String)

Region or state code.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AddedToProjectEvent\n

\n

Represents aadded_to_projectevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectCard (ProjectCard)

Project card referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n App\n

\n

A GitHub App.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the app.

\n\n\n\n\n\n\n\n\n\n\n\n

logoBackgroundColor (String!)

The hex color code, without the leading '#', for the logo background.

\n\n\n\n\n\n\n\n\n\n\n\n

logoUrl (URI!)

A URL pointing to the app's logo.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting image.

\n\n
\n\n
\n\n\n

name (String!)

The name of the app.

\n\n\n\n\n\n\n\n\n\n\n\n

slug (String!)

A slug based on the name of the app for use in URLs.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The URL to the app's homepage.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AssignedEvent\n

\n

Represents anassignedevent on any assignable object.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignable (Assignable!)

Identifies the assignable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignee (Assignee)

Identifies the user or mannequin that was assigned.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

Identifies the user who was assigned.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

user is deprecated.

Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoMergeDisabledEvent\n

\n

Represents aauto_merge_disabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

disabler (User)

The user who disabled auto-merge for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (String)

The reason auto-merge was disabled.

\n\n\n\n\n\n\n\n\n\n\n\n

reasonCode (String)

The reason_code relating to why auto-merge was disabled.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoMergeEnabledEvent\n

\n

Represents aauto_merge_enabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enabler (User)

The user who enabled auto-merge for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoMergeRequest\n

\n

Represents an auto-merge request for a pull request.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address of the author of this auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

The commit message of the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

The commit title of the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

enabledAt (DateTime)

When was this auto-merge request was enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

enabledBy (Actor)

The actor who created the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod!)

The merge method of the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request that this auto-merge request is set against.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoRebaseEnabledEvent\n

\n

Represents aauto_rebase_enabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enabler (User)

The user who enabled auto-merge (rebase) for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoSquashEnabledEvent\n

\n

Represents aauto_squash_enabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enabler (User)

The user who enabled auto-merge (squash) for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutomaticBaseChangeFailedEvent\n

\n

Represents aautomatic_base_change_failedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

newBase (String!)

The new base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

oldBase (String!)

The old base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutomaticBaseChangeSucceededEvent\n

\n

Represents aautomatic_base_change_succeededevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

newBase (String!)

The new base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

oldBase (String!)

The old base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BaseRefChangedEvent\n

\n

Represents abase_ref_changedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

currentRefName (String!)

Identifies the name of the base ref for the pull request after it was changed.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

previousRefName (String!)

Identifies the name of the base ref for the pull request before it was changed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BaseRefDeletedEvent\n

\n

Represents abase_ref_deletedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String)

Identifies the name of the Ref associated with the base_ref_deleted event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BaseRefForcePushedEvent\n

\n

Represents abase_ref_force_pushedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

afterCommit (Commit)

Identifies the after commit SHA for thebase_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeCommit (Commit)

Identifies the before commit SHA for thebase_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the fully qualified ref name for thebase_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Blame\n

\n

Represents a Git blame.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

ranges ([BlameRange!]!)

The list of ranges from a Git blame.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BlameRange\n

\n

Represents a range of information from a Git blame.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

age (Int!)

Identifies the recency of the change, from 1 (new) to 10 (old). This is\ncalculated as a 2-quantile and determines the length of distance between the\nmedian age of all the changes in the file and the recency of the current\nrange's change.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit!)

Identifies the line author.

\n\n\n\n\n\n\n\n\n\n\n\n

endingLine (Int!)

The ending line for the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startingLine (Int!)

The starting line for the range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Blob\n

\n

Represents a Git blob.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

byteSize (Int!)

Byte size of Blob object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

isBinary (Boolean)

Indicates whether the Blob is binary or text. Returns null if unable to determine the encoding.

\n\n\n\n\n\n\n\n\n\n\n\n

isTruncated (Boolean!)

Indicates whether the contents is truncated.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the Git object belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

UTF8 text data or null if the Blob is binary.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Bot\n

\n

A special type of user which takes actions on behalf of GitHub Apps.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the GitHub App's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The username of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this bot.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this bot.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRule\n

\n

A branch protection rule.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean!)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean!)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRuleConflicts (BranchProtectionRuleConflictConnection!)

A list of conflicts matching branches protection rule and other branch protection rules.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

creator (Actor)

The actor who created this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean!)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean!)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

matchingRefs (RefConnection!)

Repository refs that are protected by this rule.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters refs with query on name.

\n\n
\n\n
\n\n\n

pattern (String!)

Identifies the protection rule pattern.

\n\n\n\n\n\n\n\n\n\n\n\n

pushAllowances (PushAllowanceConnection!)

A list push allowances for this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

repository (Repository)

The repository associated with this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean!)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean!)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean!)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean!)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean!)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean!)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean!)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean!)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalAllowances (ReviewDismissalAllowanceConnection!)

A list review dismissal allowances for this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConflict\n

\n

A conflict between two branch protection rules.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

conflictingBranchProtectionRule (BranchProtectionRule)

Identifies the conflicting branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the branch ref that has conflicting rules.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConflictConnection\n

\n

The connection type for BranchProtectionRuleConflict.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([BranchProtectionRuleConflictEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([BranchProtectionRuleConflict])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConflictEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (BranchProtectionRuleConflict)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConnection\n

\n

The connection type for BranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([BranchProtectionRuleEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([BranchProtectionRule])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (BranchProtectionRule)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CVSS\n

\n

The Common Vulnerability Scoring System.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

score (Float!)

The CVSS score associated with this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

vectorString (String)

The CVSS vector string associated with this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CWE\n

\n

A common weakness enumeration.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cweId (String!)

The id of the CWE.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String!)

A detailed description of this CWE.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

ID of the object.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of this CWE.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CWEConnection\n

\n

The connection type for CWE.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CWEEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CWE])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CWEEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CWE)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotation\n

\n

A single check annotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotationLevel (CheckAnnotationLevel)

The annotation's severity level.

\n\n\n\n\n\n\n\n\n\n\n\n

blobUrl (URI!)

The path to the file that this annotation was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

location (CheckAnnotationSpan!)

The position of this annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

The annotation's message.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path that this annotation was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

rawDetails (String)

Additional information about the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The annotation's title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationConnection\n

\n

The connection type for CheckAnnotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CheckAnnotationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CheckAnnotation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CheckAnnotation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationPosition\n

\n

A character position in a check annotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

column (Int)

Column number (1 indexed).

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

Line number (1 indexed).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationSpan\n

\n

An inclusive pair of positions for a check annotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

end (CheckAnnotationPosition!)

End position (inclusive).

\n\n\n\n\n\n\n\n\n\n\n\n

start (CheckAnnotationPosition!)

Start position (inclusive).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckRun\n

\n

A check run.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotations (CheckAnnotationConnection)

The check run's annotations.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

checkSuite (CheckSuite!)

The check suite that this run is a part of.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

Identifies the date and time when the check run was completed.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The conclusion of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL from which to find full details of the check run on the integrator's site.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the check run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the check for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI!)

The permalink to the check run summary.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this check run.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

Identifies the date and time when the check run was started.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState!)

The current status of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String)

A string representing the check run's summary.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

A string representing the check run's text.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

A string representing the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckRunConnection\n

\n

The connection type for CheckRun.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CheckRunEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CheckRun])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckRunEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CheckRun)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckSuite\n

\n

A check suite.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

app (App)

The GitHub App which created this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

branch (Ref)

The name of the branch for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

checkRuns (CheckRunConnection)

The check runs associated with a check suite.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (CheckRunFilter)

\n

Filters the check runs by this type.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit!)

The commit for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The conclusion of this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

matchingPullRequests (PullRequestConnection)

A list of open pull requests matching the check suite.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

push (Push)

The push that triggered this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState!)

The status of this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckSuiteConnection\n

\n

The connection type for CheckSuite.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CheckSuiteEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CheckSuite])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckSuiteEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CheckSuite)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ClosedEvent\n

\n

Represents aclosedevent on any Closable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

closable (Closable!)

Object that was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

closer (Closer)

Object which triggered the creation of this event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this closed event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this closed event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CodeOfConduct\n

\n

The Code of Conduct for a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The key for the Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The formal name of the Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI)

The HTTP path for this Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI)

The HTTP URL for this Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommentDeletedEvent\n

\n

Represents acomment_deletedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deletedCommentAuthor (Actor)

The user who authored the deleted comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Commit\n

\n

Represents a Git commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

additions (Int!)

The number of additions in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

associatedPullRequests (PullRequestConnection)

The pull requests associated with a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (PullRequestOrder)

\n

Ordering options for pull requests.

\n\n
\n\n
\n\n\n

author (GitActor)

Authorship details of the commit.

\n\n\n\n\n\n\n\n\n\n\n\n

authoredByCommitter (Boolean!)

Check if the committer and the author match.

\n\n\n\n\n\n\n\n\n\n\n\n

authoredDate (DateTime!)

The datetime when this commit was authored.

\n\n\n\n\n\n\n\n\n\n\n\n

authors (GitActorConnection!)

The list of authors for this commit based on the git author and the Co-authored-by\nmessage trailer. The git author will always be first.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

blame (Blame!)

Fetches git blame information.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

path (String!)

\n

The file whose Git blame information you want.

\n\n
\n\n
\n\n\n

changedFiles (Int!)

The number of changed files in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

checkSuites (CheckSuiteConnection)

The check suites associated with a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (CheckSuiteFilter)

\n

Filters the check suites by this type.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

comments (CommitCommentConnection!)

Comments made on the commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

committedDate (DateTime!)

The datetime when this commit was committed.

\n\n\n\n\n\n\n\n\n\n\n\n

committedViaWeb (Boolean!)

Check if committed via GitHub web UI.

\n\n\n\n\n\n\n\n\n\n\n\n

committer (GitActor)

Committer details of the commit.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions (Int!)

The number of deletions in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

deployments (DeploymentConnection)

The deployments associated with a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

environments ([String!])

\n

Environments to list deployments for.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (DeploymentOrder)

\n

Ordering options for deployments returned from the connection.

\n\n
\n\n
\n\n\n

file (TreeEntry)

The tree entry representing the file located at the given path.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

path (String!)

\n

The path for the file.

\n\n
\n\n
\n\n\n

history (CommitHistoryConnection!)

The linear commit history starting from (and including) this commit, in the same order as git log.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

author (CommitAuthor)

\n

If non-null, filters history to only show commits with matching authorship.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

path (String)

\n

If non-null, filters history to only show commits touching files under this path.

\n\n
\n\n
\n

since (GitTimestamp)

\n

Allows specifying a beginning time or date for fetching commits.

\n\n
\n\n
\n

until (GitTimestamp)

\n

Allows specifying an ending time or date for fetching commits.

\n\n
\n\n
\n\n\n

message (String!)

The Git commit message.

\n\n\n\n\n\n\n\n\n\n\n\n

messageBody (String!)

The Git commit message body.

\n\n\n\n\n\n\n\n\n\n\n\n

messageBodyHTML (HTML!)

The commit message body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

messageHeadline (String!)

The Git commit message headline.

\n\n\n\n\n\n\n\n\n\n\n\n

messageHeadlineHTML (HTML!)

The commit message headline rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

onBehalfOf (Organization)

The organization this commit was made on behalf of.

\n\n\n\n\n\n\n\n\n\n\n\n

parents (CommitConnection!)

The parents of a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pushedDate (DateTime)

The datetime when this commit was pushed.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository this commit belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (GitSignature)

Commit signing information, if present.

\n\n\n\n\n\n\n\n\n\n\n\n

status (Status)

Status information for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

statusCheckRollup (StatusCheckRollup)

Check and Status rollup information for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

submodules (SubmoduleConnection!)

Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

tarballUrl (URI!)

Returns a URL to download a tarball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

\n\n\n\n\n\n\n\n\n\n\n\n

tree (Tree!)

Commit's root Tree.

\n\n\n\n\n\n\n\n\n\n\n\n

treeResourcePath (URI!)

The HTTP path for the tree of this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

treeUrl (URI!)

The HTTP URL for the tree of this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n

zipballUrl (URI!)

Returns a URL to download a zipball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitComment\n

\n

Represents a comment on a given Commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with the comment, if the commit exists.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

Identifies the file path associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

Identifies the line position associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path permalink for this commit comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL permalink for this commit comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitCommentConnection\n

\n

The connection type for CommitComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CommitCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CommitComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CommitComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitCommentThread\n

\n

A thread of comments on a commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (CommitCommentConnection!)

The comments that exist in this thread.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit)

The commit the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The file the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The position in the diff for the commit that the comment was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitConnection\n

\n

The connection type for Commit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CommitEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Commit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitContributionsByRepository\n

\n

This aggregates commits made by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedCommitContributionConnection!)

The commit contributions, each representing a day.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (CommitContributionOrder)

\n

Ordering options for commit contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the commits were made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for the user's commits to the repository in this time range.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for the user's commits to the repository in this time range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Commit)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitHistoryConnection\n

\n

The connection type for Commit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CommitEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Commit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ConnectedEvent\n

\n

Represents aconnectedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

source (ReferencedSubject!)

Issue or pull request that made the reference.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (ReferencedSubject!)

Issue or pull request which was connected.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContentAttachment\n

\n

A content attachment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body text of the content attachment. This parameter supports markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

contentReference (ContentReference!)

The content reference that the content attachment is attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int!)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the content attachment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContentReference\n

\n

A content reference.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

databaseId (Int!)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

reference (String!)

The reference of the content reference.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendar\n

\n

A calendar of contributions made on GitHub by a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

colors ([String!]!)

A list of hex color codes used in this calendar. The darker the color, the more contributions it represents.

\n\n\n\n\n\n\n\n\n\n\n\n

isHalloween (Boolean!)

Determine if the color set was chosen because it's currently Halloween.

\n\n\n\n\n\n\n\n\n\n\n\n

months ([ContributionCalendarMonth!]!)

A list of the months of contributions in this calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

totalContributions (Int!)

The count of total contributions in the calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

weeks ([ContributionCalendarWeek!]!)

A list of the weeks of contributions in this calendar.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendarDay\n

\n

Represents a single day of contributions on GitHub by a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

color (String!)

The hex color code that represents how many contributions were made on this day compared to others in the calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionCount (Int!)

How many contributions were made by the user on this day.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionLevel (ContributionLevel!)

Indication of contributions, relative to other days. Can be used to indicate\nwhich color to represent this day on a calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

date (Date!)

The day this square represents.

\n\n\n\n\n\n\n\n\n\n\n\n

weekday (Int!)

A number representing which day of the week this square represents, e.g., 1 is Monday.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendarMonth\n

\n

A month of contributions in a user's contribution graph.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

firstDay (Date!)

The date of the first day of this month.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the month.

\n\n\n\n\n\n\n\n\n\n\n\n

totalWeeks (Int!)

How many weeks started in this month.

\n\n\n\n\n\n\n\n\n\n\n\n

year (Int!)

The year the month occurred in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendarWeek\n

\n

A week of contributions in a user's contribution graph.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributionDays ([ContributionCalendarDay!]!)

The days of contributions in this week.

\n\n\n\n\n\n\n\n\n\n\n\n

firstDay (Date!)

The date of the earliest square in this week.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionsCollection\n

\n

A contributions collection aggregates contributions such as opened issues and commits created by a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commitContributionsByRepository ([CommitContributionsByRepository!]!)

Commit contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

contributionCalendar (ContributionCalendar!)

A calendar of this user's contributions on GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionYears ([Int!]!)

The years the user has been making contributions with the most recent year first.

\n\n\n\n\n\n\n\n\n\n\n\n

doesEndInCurrentMonth (Boolean!)

Determine if this collection's time span ends in the current month.

\n\n\n\n\n\n\n\n\n\n\n\n

earliestRestrictedContributionDate (Date)

The date of the first restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

endedAt (DateTime!)

The ending date and time of this collection.

\n\n\n\n\n\n\n\n\n\n\n\n

firstIssueContribution (CreatedIssueOrRestrictedContribution)

The first issue the user opened on GitHub. This will be null if that issue was\nopened outside the collection's time range and ignoreTimeRange is false. If\nthe issue is not visible but the user has opted to show private contributions,\na RestrictedContribution will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

firstPullRequestContribution (CreatedPullRequestOrRestrictedContribution)

The first pull request the user opened on GitHub. This will be null if that\npull request was opened outside the collection's time range and\nignoreTimeRange is not true. If the pull request is not visible but the user\nhas opted to show private contributions, a RestrictedContribution will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

firstRepositoryContribution (CreatedRepositoryOrRestrictedContribution)

The first repository the user created on GitHub. This will be null if that\nfirst repository was created outside the collection's time range and\nignoreTimeRange is false. If the repository is not visible, then a\nRestrictedContribution is returned.

\n\n\n\n\n\n\n\n\n\n\n\n

hasActivityInThePast (Boolean!)

Does the user have any more activity in the timeline that occurred prior to the collection's time range?.

\n\n\n\n\n\n\n\n\n\n\n\n

hasAnyContributions (Boolean!)

Determine if there are any contributions in this collection.

\n\n\n\n\n\n\n\n\n\n\n\n

hasAnyRestrictedContributions (Boolean!)

Determine if the user made any contributions in this time frame whose details\nare not visible because they were made in a private repository. Can only be\ntrue if the user enabled private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

isSingleDay (Boolean!)

Whether or not the collector's time span is all within the same day.

\n\n\n\n\n\n\n\n\n\n\n\n

issueContributions (CreatedIssueContributionConnection!)

A list of issues the user opened.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

issueContributionsByRepository ([IssueContributionsByRepository!]!)

Issue contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

joinedGitHubContribution (JoinedGitHubContribution)

When the user signed up for GitHub. This will be null if that sign up date\nfalls outside the collection's time range and ignoreTimeRange is false.

\n\n\n\n\n\n\n\n\n\n\n\n

latestRestrictedContributionDate (Date)

The date of the most recent restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

mostRecentCollectionWithActivity (ContributionsCollection)

When this collection's time range does not include any activity from the user, use this\nto get a different collection from an earlier time range that does have activity.

\n\n\n\n\n\n\n\n\n\n\n\n

mostRecentCollectionWithoutActivity (ContributionsCollection)

Returns a different contributions collection from an earlier time range than this one\nthat does not have any contributions.

\n\n\n\n\n\n\n\n\n\n\n\n

popularIssueContribution (CreatedIssueContribution)

The issue the user opened on GitHub that received the most comments in the specified\ntime frame.

\n\n\n\n\n\n\n\n\n\n\n\n

popularPullRequestContribution (CreatedPullRequestContribution)

The pull request the user opened on GitHub that received the most comments in the\nspecified time frame.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestContributions (CreatedPullRequestContributionConnection!)

Pull request contributions made by the user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

pullRequestContributionsByRepository ([PullRequestContributionsByRepository!]!)

Pull request contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

pullRequestReviewContributions (CreatedPullRequestReviewContributionConnection!)

Pull request review contributions made by the user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

pullRequestReviewContributionsByRepository ([PullRequestReviewContributionsByRepository!]!)

Pull request review contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

repositoryContributions (CreatedRepositoryContributionConnection!)

A list of repositories owned by the user that the user created in this time range.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first repository ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

restrictedContributionsCount (Int!)

A count of contributions made by the user that the viewer cannot access. Only\nnon-zero when the user has chosen to share their private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime!)

The beginning date and time of this collection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCommitContributions (Int!)

How many commits were made by the user in this time span.

\n\n\n\n\n\n\n\n\n\n\n\n

totalIssueContributions (Int!)

How many issues the user opened.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalPullRequestContributions (Int!)

How many pull requests the user opened.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalPullRequestReviewContributions (Int!)

How many pull request reviews the user left.

\n\n\n\n\n\n\n\n\n\n\n\n

totalRepositoriesWithContributedCommits (Int!)

How many different repositories the user committed to.

\n\n\n\n\n\n\n\n\n\n\n\n

totalRepositoriesWithContributedIssues (Int!)

How many different repositories the user opened issues in.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalRepositoriesWithContributedPullRequestReviews (Int!)

How many different repositories the user left pull request reviews in.

\n\n\n\n\n\n\n\n\n\n\n\n

totalRepositoriesWithContributedPullRequests (Int!)

How many different repositories the user opened pull requests in.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalRepositoryContributions (Int!)

How many repositories the user created.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first repository ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

user (User!)

The user who made the contributions in this collection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ConvertToDraftEvent\n

\n

Represents aconvert_to_draftevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this convert to draft event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this convert to draft event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ConvertedNoteToIssueEvent\n

\n

Represents aconverted_note_to_issueevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectCard (ProjectCard)

Project card referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedCommitContribution\n

\n

Represents the contribution a user made by committing to a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commitCount (Int!)

How many commits were made on this day to this repository by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository the user made a commit in.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedCommitContributionConnection\n

\n

The connection type for CreatedCommitContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedCommitContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedCommitContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of commits across days and repositories in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedCommitContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedCommitContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedIssueContribution\n

\n

Represents the contribution a user made on GitHub by opening an issue.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

The issue that was opened.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedIssueContributionConnection\n

\n

The connection type for CreatedIssueContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedIssueContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedIssueContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedIssueContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedIssueContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestContribution\n

\n

Represents the contribution a user made on GitHub by opening a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request that was opened.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestContributionConnection\n

\n

The connection type for CreatedPullRequestContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedPullRequestContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedPullRequestContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedPullRequestContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestReviewContribution\n

\n

Represents the contribution a user made by leaving a review on a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request the user reviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReview (PullRequestReview!)

The review the user left on the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository containing the pull request that the user reviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestReviewContributionConnection\n

\n

The connection type for CreatedPullRequestReviewContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedPullRequestReviewContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedPullRequestReviewContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestReviewContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedPullRequestReviewContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedRepositoryContribution\n

\n

Represents the contribution a user made on GitHub by creating a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository that was created.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedRepositoryContributionConnection\n

\n

The connection type for CreatedRepositoryContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedRepositoryContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedRepositoryContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedRepositoryContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedRepositoryContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CrossReferencedEvent\n

\n

Represents a mention made by one issue or pull request to another.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

referencedAt (DateTime!)

Identifies when the reference was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

source (ReferencedSubject!)

Issue or pull request that made the reference.

\n\n\n\n\n\n\n\n\n\n\n\n

target (ReferencedSubject!)

Issue or pull request to which the reference was made.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

willCloseTarget (Boolean!)

Checks if the target will be closed when the source is merged.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DemilestonedEvent\n

\n

Represents ademilestonedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneTitle (String!)

Identifies the milestone title associated with thedemilestonedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (MilestoneItem!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployKey\n

\n

A repository deploy key.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The deploy key.

\n\n\n\n\n\n\n\n\n\n\n\n

readOnly (Boolean!)

Whether or not the deploy key is read only.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The deploy key title.

\n\n\n\n\n\n\n\n\n\n\n\n

verified (Boolean!)

Whether or not the deploy key has been verified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployKeyConnection\n

\n

The connection type for DeployKey.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeployKeyEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([DeployKey])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployKeyEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (DeployKey)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployedEvent\n

\n

Represents adeployedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deployment (Deployment!)

The deployment associated with thedeployedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

The ref associated with thedeployedevent.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Deployment\n

\n

Represents triggered deployment instance.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commit (Commit)

Identifies the commit sha of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOid (String!)

Identifies the oid of the deployment commit, even if the commit has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor!)

Identifies the actor who triggered the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The deployment description.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

The latest environment to which this deployment was made.

\n\n\n\n\n\n\n\n\n\n\n\n

latestEnvironment (String)

The latest environment to which this deployment was made.

\n\n\n\n\n\n\n\n\n\n\n\n

latestStatus (DeploymentStatus)

The latest status of this deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

originalEnvironment (String)

The original environment to which this deployment was made.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String)

Extra information that a deployment system might need.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the Ref of the deployment, if the deployment was created by ref.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

Identifies the repository associated with the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentState)

The current state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

statuses (DeploymentStatusConnection)

A list of statuses associated with the deployment.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

task (String)

The deployment task.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentConnection\n

\n

The connection type for Deployment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeploymentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Deployment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Deployment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentEnvironmentChangedEvent\n

\n

Represents adeployment_environment_changedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

deploymentStatus (DeploymentStatus!)

The deployment status that updated the deployment environment.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentStatus\n

\n

Describes the status of a given deployment attempt.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor!)

Identifies the actor who triggered the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

deployment (Deployment!)

Identifies the deployment associated with status.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Identifies the description of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

Identifies the environment of the deployment at the time of this deployment status.

\n\n\n\n\n
\n

Preview notice

\n

environment is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

environmentUrl (URI)

Identifies the environment URL of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

logUrl (URI)

Identifies the log URL of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentStatusState!)

Identifies the current state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentStatusConnection\n

\n

The connection type for DeploymentStatus.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeploymentStatusEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([DeploymentStatus])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentStatusEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (DeploymentStatus)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DisconnectedEvent\n

\n

Represents adisconnectedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

source (ReferencedSubject!)

Issue or pull request from which the issue was disconnected.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (ReferencedSubject!)

Issue or pull request which was disconnected.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Enterprise\n

\n

An account to manage multiple organizations with consolidated policy and billing.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the enterprise's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

billingInfo (EnterpriseBillingInfo)

Enterprise billing information visible to enterprise billing managers.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML!)

The description of the enterprise as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The location of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

members (EnterpriseMemberConnection!)

A list of users who are members of this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

deployment (EnterpriseUserDeployment)

\n

Only return members within the selected GitHub Enterprise deployment.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for members returned from the connection.

\n\n
\n\n
\n

organizationLogins ([String!])

\n

Only return members within the organizations with these logins.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseUserAccountMembershipRole)

\n

The role of the user in the enterprise organization or server.

\n\n
\n\n
\n\n\n

name (String!)

The name of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

organizations (OrganizationConnection!)

A list of organizations that belong to this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

ownerInfo (EnterpriseOwnerInfo)

Enterprise information only visible to enterprise owners.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

slug (String!)

The URL-friendly identifier for the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

userAccounts (EnterpriseUserAccountConnection!)

A list of user accounts on this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerIsAdmin (Boolean!)

Is the current viewer an admin of this enterprise?.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (URI)

The URL of the enterprise website.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseAdministratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorEdge\n

\n

A User who is an administrator of an enterprise.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole!)

The role of the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitation\n

\n

An invitation for a user to become an owner or billing manager of an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email of the person who was invited to the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise!)

The enterprise the invitation is for.

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (User)

The user who was invited to the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

inviter (User)

The user who created the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole!)

The invitee's pending role in the enterprise (owner or billing_manager).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationConnection\n

\n

The connection type for EnterpriseAdministratorInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseAdministratorInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseAdministratorInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseAdministratorInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseBillingInfo\n

\n

Enterprise billing information visible to enterprise billing managers and owners.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allLicensableUsersCount (Int!)

The number of licenseable users/emails across the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

assetPacks (Int!)

The number of data packs used by all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

availableSeats (Int!)

The number of available seats across all owned organizations based on the unique number of billable users.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

availableSeats is deprecated.

availableSeats will be replaced with totalAvailableLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalAvailableLicenses instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n

bandwidthQuota (Float!)

The bandwidth quota in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

bandwidthUsage (Float!)

The bandwidth usage in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

bandwidthUsagePercentage (Int!)

The bandwidth usage as a percentage of the bandwidth quota.

\n\n\n\n\n\n\n\n\n\n\n\n

seats (Int!)

The total seats across all organizations owned by the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

seats is deprecated.

seats will be replaced with totalLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalLicenses instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n

storageQuota (Float!)

The storage quota in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

storageUsage (Float!)

The storage usage in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

storageUsagePercentage (Int!)

The storage usage as a percentage of the storage quota.

\n\n\n\n\n\n\n\n\n\n\n\n

totalAvailableLicenses (Int!)

The number of available licenses across all owned organizations based on the unique number of billable users.

\n\n\n\n\n\n\n\n\n\n\n\n

totalLicenses (Int!)

The total number of licenses allocated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseIdentityProvider\n

\n

An identity provider configured to provision identities for an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

digestMethod (SamlDigestAlgorithm)

The digest algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise)

The enterprise this identity provider belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

externalIdentities (ExternalIdentityConnection!)

ExternalIdentities provisioned by this identity provider.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

idpCertificate (X509Certificate)

The x509 certificate used by the identity provider to sign assertions and responses.

\n\n\n\n\n\n\n\n\n\n\n\n

issuer (String)

The Issuer Entity ID for the SAML identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

recoveryCodes ([String!])

Recovery codes that can be used by admins to access the enterprise if the identity provider is unavailable.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethod (SamlSignatureAlgorithm)

The signature algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

ssoUrl (URI)

The URL endpoint for the identity provider's SAML SSO.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberConnection\n

\n

The connection type for EnterpriseMember.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseMemberEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseMember])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberEdge\n

\n

A User who is a member of an enterprise through one or more organizations.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the user does not have a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All members consume a license Removal on 2021-01-01 UTC.

\n
\n\n\n\n\n\n\n

node (EnterpriseMember)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOrganizationMembershipConnection\n

\n

The connection type for Organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseOrganizationMembershipEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Organization])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOrganizationMembershipEdge\n

\n

An enterprise organization that a user is a member of.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Organization)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseUserAccountMembershipRole!)

The role of the user in the enterprise membership.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOutsideCollaboratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseOutsideCollaboratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOutsideCollaboratorEdge\n

\n

A User who is an outside collaborator of an enterprise through one or more organizations.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the outside collaborator does not have a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All outside collaborators consume a license Removal on 2021-01-01 UTC.

\n
\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (EnterpriseRepositoryInfoConnection!)

The enterprise organization repositories this user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOwnerInfo\n

\n

Enterprise information only visible to enterprise owners.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

admins (EnterpriseAdministratorConnection!)

A list of all of the administrators for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for administrators returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseAdministratorRole)

\n

The role to filter by.

\n\n
\n\n
\n\n\n

affiliatedUsersWithTwoFactorDisabled (UserConnection!)

A list of users in the enterprise who currently have two-factor authentication disabled.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

affiliatedUsersWithTwoFactorDisabledExist (Boolean!)

Whether or not affiliated users with two-factor authentication disabled exist in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

allowPrivateRepositoryForkingSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether private repository forking is enabled for repositories in organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

allowPrivateRepositoryForkingSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided private repository forking setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

defaultRepositoryPermissionSetting (EnterpriseDefaultRepositoryPermissionSettingValue!)

The setting value for base repository permissions for organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

defaultRepositoryPermissionSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided default repository permission.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (DefaultRepositoryPermissionField!)

\n

The permission to find organizations for.

\n\n
\n\n
\n\n\n

ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

The setting value for whether the enterprise has an IP allow list enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntries (IpAllowListEntryConnection!)

The IP addresses that are allowed to access resources owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IpAllowListEntryOrder)

\n

Ordering options for IP allow list entries returned.

\n\n
\n\n
\n\n\n

isUpdatingDefaultRepositoryPermission (Boolean!)

Whether or not the default repository permission is currently being updated.

\n\n\n\n\n\n\n\n\n\n\n\n

isUpdatingTwoFactorRequirement (Boolean!)

Whether the two-factor authentication requirement is currently being enforced.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanChangeRepositoryVisibilitySetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether organization members with admin permissions on a\nrepository can change repository visibility.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanChangeRepositoryVisibilitySettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided can change repository visibility setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanCreateInternalRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create internal repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePrivateRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create private repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePublicRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create public repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesSetting (EnterpriseMembersCanCreateRepositoriesSettingValue)

The setting value for whether members of organizations in the enterprise can create repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided repository creation setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (OrganizationMembersCanCreateRepositoriesSettingValue!)

\n

The setting to find organizations for.

\n\n
\n\n
\n\n\n

membersCanDeleteIssuesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can delete issues.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanDeleteIssuesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can delete issues setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanDeleteRepositoriesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can delete or transfer repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanDeleteRepositoriesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can delete repositories setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanInviteCollaboratorsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members of organizations in the enterprise can invite outside collaborators.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanInviteCollaboratorsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can invite collaborators setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanMakePurchasesSetting (EnterpriseMembersCanMakePurchasesSettingValue!)

Indicates whether members of this enterprise's organizations can purchase additional services for those organizations.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanUpdateProtectedBranchesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can update protected branches.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanUpdateProtectedBranchesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can update protected branches setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanViewDependencyInsightsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members can view dependency insights.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanViewDependencyInsightsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can view dependency insights setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

organizationProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether organization projects are enabled for organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationProjectsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided organization projects setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

outsideCollaborators (EnterpriseOutsideCollaboratorConnection!)

A list of outside collaborators across the repositories in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

login (String)

\n

The login of one specific outside collaborator.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for outside collaborators returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

visibility (RepositoryVisibility)

\n

Only return outside collaborators on repositories with this visibility.

\n\n
\n\n
\n\n\n

pendingAdminInvitations (EnterpriseAdministratorInvitationConnection!)

A list of pending administrator invitations for the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseAdministratorInvitationOrder)

\n

Ordering options for pending enterprise administrator invitations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseAdministratorRole)

\n

The role to filter by.

\n\n
\n\n
\n\n\n

pendingCollaboratorInvitations (RepositoryInvitationConnection!)

A list of pending collaborator invitations across the repositories in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryInvitationOrder)

\n

Ordering options for pending repository collaborator invitations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

pendingCollaborators (EnterprisePendingCollaboratorConnection!)

A list of pending collaborators across the repositories in the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

pendingCollaborators is deprecated.

Repository invitations can now be associated with an email, not only an invitee. Use the pendingCollaboratorInvitations field instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryInvitationOrder)

\n

Ordering options for pending repository collaborator invitations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

pendingMemberInvitations (EnterprisePendingMemberInvitationConnection!)

A list of pending member invitations for organizations in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

repositoryProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether repository projects are enabled in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryProjectsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided repository projects setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

samlIdentityProvider (EnterpriseIdentityProvider)

The SAML Identity Provider for the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

samlIdentityProviderSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the SAML single sign-on setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (IdentityProviderConfigurationState!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

teamDiscussionsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether team discussions are enabled for organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

teamDiscussionsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided team discussions setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

twoFactorRequiredSetting (EnterpriseEnabledSettingValue!)

The setting value for whether the enterprise requires two-factor authentication for its organizations and users.

\n\n\n\n\n\n\n\n\n\n\n\n

twoFactorRequiredSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the two-factor authentication setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingCollaboratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterprisePendingCollaboratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingCollaboratorEdge\n

\n

A user with an invitation to be a collaborator on a repository owned by an organization in an enterprise.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the invited collaborator does not have a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All pending collaborators consume a license Removal on 2021-01-01 UTC.

\n
\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (EnterpriseRepositoryInfoConnection!)

The enterprise organization repositories this user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingMemberInvitationConnection\n

\n

The connection type for OrganizationInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterprisePendingMemberInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([OrganizationInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalUniqueUserCount (Int!)

Identifies the total count of unique users in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingMemberInvitationEdge\n

\n

An invitation to be a member in an enterprise organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the invitation has a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All pending members consume a license Removal on 2020-07-01 UTC.

\n
\n\n\n\n\n\n\n

node (OrganizationInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseRepositoryInfo\n

\n

A subset of repository information queryable from an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isPrivate (Boolean!)

Identifies if the repository is private.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The repository's name.

\n\n\n\n\n\n\n\n\n\n\n\n

nameWithOwner (String!)

The repository's name with owner.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseRepositoryInfoConnection\n

\n

The connection type for EnterpriseRepositoryInfo.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseRepositoryInfoEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseRepositoryInfo])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseRepositoryInfoEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseRepositoryInfo)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerInstallation\n

\n

An Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

customerName (String!)

The customer name to which the Enterprise Server installation belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

hostName (String!)

The host name of the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

isConnected (Boolean!)

Whether or not the installation is connected to an Enterprise Server installation via GitHub Connect.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

userAccounts (EnterpriseServerUserAccountConnection!)

User accounts on this Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerUserAccountOrder)

\n

Ordering options for Enterprise Server user accounts returned from the connection.

\n\n
\n\n
\n\n\n

userAccountsUploads (EnterpriseServerUserAccountsUploadConnection!)

User accounts uploads for the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerUserAccountsUploadOrder)

\n

Ordering options for Enterprise Server user accounts uploads returned from the connection.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccount\n

\n

A user account on an Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

emails (EnterpriseServerUserAccountEmailConnection!)

User emails belonging to this user account.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerUserAccountEmailOrder)

\n

Ordering options for Enterprise Server user account emails returned from the connection.

\n\n
\n\n
\n\n\n

enterpriseServerInstallation (EnterpriseServerInstallation!)

The Enterprise Server installation on which this user account exists.

\n\n\n\n\n\n\n\n\n\n\n\n

isSiteAdmin (Boolean!)

Whether the user account is a site administrator on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user account on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

profileName (String)

The profile name of the user account on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

remoteCreatedAt (DateTime!)

The date and time when the user account was created on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

remoteUserId (Int!)

The ID of the user account on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountConnection\n

\n

The connection type for EnterpriseServerUserAccount.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerUserAccountEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerUserAccount])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerUserAccount)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmail\n

\n

An email belonging to a user account on an Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String!)

The email address.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrimary (Boolean!)

Indicates whether this is the primary email of the associated user account.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

userAccount (EnterpriseServerUserAccount!)

The user account to which the email belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailConnection\n

\n

The connection type for EnterpriseServerUserAccountEmail.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerUserAccountEmailEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerUserAccountEmail])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerUserAccountEmail)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUpload\n

\n

A user accounts upload from an Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise!)

The enterprise to which this upload belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseServerInstallation (EnterpriseServerInstallation!)

The Enterprise Server installation for which this upload was generated.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the file uploaded.

\n\n\n\n\n\n\n\n\n\n\n\n

syncState (EnterpriseServerUserAccountsUploadSyncState!)

The synchronization state of the upload.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadConnection\n

\n

The connection type for EnterpriseServerUserAccountsUpload.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerUserAccountsUploadEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerUserAccountsUpload])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerUserAccountsUpload)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseUserAccount\n

\n

An account for a user who is an admin of an enterprise or a member of an enterprise through one or more organizations.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the enterprise user account's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise!)

The enterprise in which this user account exists.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

An identifier for the enterprise user account, a login or email address.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the enterprise user account.

\n\n\n\n\n\n\n\n\n\n\n\n

organizations (EnterpriseOrganizationMembershipConnection!)

A list of enterprise organizations this user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseUserAccountMembershipRole)

\n

The role of the user in the enterprise organization.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user within the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseUserAccountConnection\n

\n

The connection type for EnterpriseUserAccount.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseUserAccountEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseUserAccount])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseUserAccountEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseUserAccount)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentity\n

\n

An external identity provisioned by SAML SSO or SCIM.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

guid (String!)

The GUID for this identity.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationInvitation (OrganizationInvitation)

Organization invitation for this SCIM-provisioned external identity.

\n\n\n\n\n\n\n\n\n\n\n\n

samlIdentity (ExternalIdentitySamlAttributes)

SAML Identity attributes.

\n\n\n\n\n\n\n\n\n\n\n\n

scimIdentity (ExternalIdentityScimAttributes)

SCIM Identity attributes.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentityConnection\n

\n

The connection type for ExternalIdentity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ExternalIdentityEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ExternalIdentity])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentityEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ExternalIdentity)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentitySamlAttributes\n

\n

SAML attributes for the External Identity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([UserEmailMetadata!])

The emails associated with the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

familyName (String)

Family name of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

givenName (String)

Given name of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

groups ([String!])

The groups linked to this identity in IDP.

\n\n\n\n\n\n\n\n\n\n\n\n

nameId (String)

The NameID of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

username (String)

The userName of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentityScimAttributes\n

\n

SCIM attributes for the External Identity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([UserEmailMetadata!])

The emails associated with the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n

familyName (String)

Family name of the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n

givenName (String)

Given name of the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n

groups ([String!])

The groups linked to this identity in IDP.

\n\n\n\n\n\n\n\n\n\n\n\n

username (String)

The userName of the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n FollowerConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n FollowingConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GenericHovercardContext\n

\n

A generic hovercard context with a message and icon.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Gist\n

\n

A Gist.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (GistCommentConnection!)

A list of comments associated with the gist.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The gist description.

\n\n\n\n\n\n\n\n\n\n\n\n

files ([GistFile])

The files in this gist.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

limit (Int)

\n

The maximum number of files to return.

\n

The default value is 10.

\n
\n\n
\n

oid (GitObjectID)

\n

The oid of the files to return.

\n\n
\n\n
\n\n\n

forks (GistConnection!)

A list of forks associated with the gist.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (GistOrder)

\n

Ordering options for gists returned from the connection.

\n\n
\n\n
\n\n\n

isFork (Boolean!)

Identifies if the gist is a fork.

\n\n\n\n\n\n\n\n\n\n\n\n

isPublic (Boolean!)

Whether the gist is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The gist name.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (RepositoryOwner)

The gist owner.

\n\n\n\n\n\n\n\n\n\n\n\n

pushedAt (DateTime)

Identifies when the gist was last pushed to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTML path to this resource.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this Gist.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistComment\n

\n

Represents a comment on an Gist.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the gist.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

gist (Gist!)

The associated gist.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistCommentConnection\n

\n

The connection type for GistComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([GistCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([GistComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (GistComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistConnection\n

\n

The connection type for Gist.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([GistEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Gist])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Gist)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistFile\n

\n

A file in a gist.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

encodedName (String)

The file name encoded to remove characters that are invalid in URL paths.

\n\n\n\n\n\n\n\n\n\n\n\n

encoding (String)

The gist file encoding.

\n\n\n\n\n\n\n\n\n\n\n\n

extension (String)

The file extension from the file name.

\n\n\n\n\n\n\n\n\n\n\n\n

isImage (Boolean!)

Indicates if this file is an image.

\n\n\n\n\n\n\n\n\n\n\n\n

isTruncated (Boolean!)

Whether the file's contents were truncated.

\n\n\n\n\n\n\n\n\n\n\n\n

language (Language)

The programming language this file is written in.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The gist file name.

\n\n\n\n\n\n\n\n\n\n\n\n

size (Int)

The gist file size in bytes.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

UTF8 text data or null if the file is binary.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

truncate (Int)

\n

Optionally truncate the returned file to this length.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitActor\n

\n

Represents an actor in a Git commit (ie. an author or committer).

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the author's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

date (GitTimestamp)

The timestamp of the Git action (authoring or committing).

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email in the Git commit.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name in the Git commit.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The GitHub user corresponding to the email field. Null if no such user exists.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitActorConnection\n

\n

The connection type for GitActor.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([GitActorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([GitActor])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitActorEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (GitActor)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitHubMetadata\n

\n

Represents information about the GitHub instance.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

gitHubServicesSha (GitObjectID!)

Returns a String that's a SHA of github-services.

\n\n\n\n\n\n\n\n\n\n\n\n

isPasswordAuthenticationVerifiable (Boolean!)

Whether or not users are verified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GpgSignature\n

\n

Represents a GPG signature on a Commit or Tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String!)

Email used to sign this object.

\n\n\n\n\n\n\n\n\n\n\n\n

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

keyId (String)

Hex-encoded ID of the key that signed this object.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (String!)

ASCII-armored signature header from object.

\n\n\n\n\n\n\n\n\n\n\n\n

signer (User)

GitHub user corresponding to the email signing this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

\n\n\n\n\n\n\n\n\n\n\n\n

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n HeadRefDeletedEvent\n

\n

Represents ahead_ref_deletedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

headRef (Ref)

Identifies the Ref associated with the head_ref_deleted event.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

Identifies the name of the Ref associated with the head_ref_deleted event.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n HeadRefForcePushedEvent\n

\n

Represents ahead_ref_force_pushedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

afterCommit (Commit)

Identifies the after commit SHA for thehead_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeCommit (Commit)

Identifies the before commit SHA for thehead_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the fully qualified ref name for thehead_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n HeadRefRestoredEvent\n

\n

Represents ahead_ref_restoredevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Hovercard\n

\n

Detail needed to display a hovercard for a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

contexts ([HovercardContext!]!)

Each of the contexts for this hovercard.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IpAllowListEntry\n

\n

An IP address or range of addresses that is allowed to access an owner's resources.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

A single IP address or range of IP addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the entry is currently active.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (IpAllowListOwner!)

The owner of the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryConnection\n

\n

The connection type for IpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IpAllowListEntryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IpAllowListEntry])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IpAllowListEntry)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Issue\n

\n

An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

activeLockReason (LockReason)

Reason that the conversation was locked.

\n\n\n\n\n\n\n\n\n\n\n\n

assignees (UserConnection!)

A list of Users assigned to this object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the body of the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyResourcePath (URI!)

The http path for this issue body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

Identifies the body of the issue rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyUrl (URI!)

The http URL for this issue body.

\n\n\n\n\n\n\n\n\n\n\n\n

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (IssueCommentConnection!)

A list of comments associated with the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueCommentOrder)

\n

Ordering options for issue comments returned from the connection.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

hovercard (Hovercard!)

The hovercard information for this issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

includeNotificationContexts (Boolean)

\n

Whether or not to include notification contexts.

\n

The default value is true.

\n
\n\n
\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isReadByViewer (Boolean)

Is this issue read by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

labels (LabelConnection)

A list of labels associated with the object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

locked (Boolean!)

true if the object is locked.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (Milestone)

Identifies the milestone associated with the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the issue number.

\n\n\n\n\n\n\n\n\n\n\n\n

participants (UserConnection!)

A list of Users that are participating in the Issue conversation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

projectCards (ProjectCardConnection!)

List of project cards associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

state (IssueState!)

Identifies the state of the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

timeline (IssueTimelineConnection!)

A list of events, comments, commits, etc. associated with the issue.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

timeline is deprecated.

timeline will be removed Use Issue.timelineItems instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Allows filtering timeline events by a since timestamp.

\n\n
\n\n
\n\n\n

timelineItems (IssueTimelineItemsConnection!)

A list of events, comments, commits, etc. associated with the issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

itemTypes ([IssueTimelineItemsItemType!])

\n

Filter timeline items by type.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Filter timeline items by a since timestamp.

\n\n
\n\n
\n

skip (Int)

\n

Skips the first n elements in the list.

\n\n
\n\n
\n\n\n

title (String!)

Identifies the issue title.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueComment\n

\n

Represents a comment on an Issue.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

Returns the pull request associated with the comment, if this comment was made on a\npull request.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this issue comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this issue comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueCommentConnection\n

\n

The connection type for IssueComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IssueComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IssueComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueConnection\n

\n

The connection type for Issue.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Issue])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueContributionsByRepository\n

\n

This aggregates issues opened by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedIssueContributionConnection!)

The issue contributions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the issues were opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Issue)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTemplate\n

\n

A repository issue template.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

about (String)

The template purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The suggested issue body.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The template name.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The suggested issue title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineConnection\n

\n

The connection type for IssueTimelineItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueTimelineItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IssueTimelineItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IssueTimelineItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineItemsConnection\n

\n

The connection type for IssueTimelineItems.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueTimelineItemsEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

filteredCount (Int!)

Identifies the count of items after applying before and after filters.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IssueTimelineItems])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageCount (Int!)

Identifies the count of items after applying before/after filters and first/last/skip slicing.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the timeline was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineItemsEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IssueTimelineItems)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n JoinedGitHubContribution\n

\n

Represents a user signing up for a GitHub account.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Label\n

\n

A label for categorizing Issues or Milestones with a given Repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

color (String!)

Identifies the label color.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime)

Identifies the date and time when the label was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of this label.

\n\n\n\n\n\n\n\n\n\n\n\n

isDefault (Boolean!)

Indicates whether or not this is a default label.

\n\n\n\n\n\n\n\n\n\n\n\n

issues (IssueConnection!)

A list of issues associated with this label.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

name (String!)

Identifies the label name.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests associated with this label.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this label.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this label.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime)

Identifies the date and time when the label was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LabelConnection\n

\n

The connection type for Label.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([LabelEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Label])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LabelEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Label)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LabeledEvent\n

\n

Represents alabeledevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

label (Label!)

Identifies the label associated with thelabeledevent.

\n\n\n\n\n\n\n\n\n\n\n\n

labelable (Labelable!)

Identifies the Labelable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Language\n

\n

Represents a given language found in repositories.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

color (String)

The color defined for the current language.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the current language.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LanguageConnection\n

\n

A list of languages associated with the parent.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([LanguageEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Language])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalSize (Int!)

The total size in bytes of files written in that language.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LanguageEdge\n

\n

Represents the language of a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

size (Int!)

The number of bytes of code written in the language.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n License\n

\n

A repository's open source license.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The full text of the license.

\n\n\n\n\n\n\n\n\n\n\n\n

conditions ([LicenseRule]!)

The conditions set by the license.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A human-readable description of the license.

\n\n\n\n\n\n\n\n\n\n\n\n

featured (Boolean!)

Whether the license should be featured.

\n\n\n\n\n\n\n\n\n\n\n\n

hidden (Boolean!)

Whether the license should be displayed in license pickers.

\n\n\n\n\n\n\n\n\n\n\n\n

implementation (String)

Instructions on how to implement the license.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The lowercased SPDX ID of the license.

\n\n\n\n\n\n\n\n\n\n\n\n

limitations ([LicenseRule]!)

The limitations set by the license.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The license full name specified by https://spdx.org/licenses.

\n\n\n\n\n\n\n\n\n\n\n\n

nickname (String)

Customary short name if applicable (e.g, GPLv3).

\n\n\n\n\n\n\n\n\n\n\n\n

permissions ([LicenseRule]!)

The permissions set by the license.

\n\n\n\n\n\n\n\n\n\n\n\n

pseudoLicense (Boolean!)

Whether the license is a pseudo-license placeholder (e.g., other, no-license).

\n\n\n\n\n\n\n\n\n\n\n\n

spdxId (String)

Short identifier specified by https://spdx.org/licenses.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI)

URL to the license on https://choosealicense.com.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LicenseRule\n

\n

Describes a License's conditions, permissions, and limitations.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String!)

A description of the rule.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The machine-readable rule key.

\n\n\n\n\n\n\n\n\n\n\n\n

label (String!)

The human-readable rule label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LockedEvent\n

\n

Represents alockedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (LockReason)

Reason that the conversation was locked (optional).

\n\n\n\n\n\n\n\n\n\n\n\n

lockable (Lockable!)

Object that was locked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Mannequin\n

\n

A placeholder user for attribution of imported data on GitHub.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the GitHub App's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The mannequin's email on the source instance.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The username of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTML path to this resource.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The URL to this resource.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MarkedAsDuplicateEvent\n

\n

Represents amarked_as_duplicateevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

canonical (IssueOrPullRequest)

The authoritative issue or pull request which has been duplicated by another.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicate (IssueOrPullRequest)

The issue or pull request which has been marked as a duplicate of another.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Canonical and duplicate belong to different repositories.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MembersCanDeleteReposClearAuditEntry\n

\n

Audit log entry for a members_can_delete_repos.clear event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MembersCanDeleteReposDisableAuditEntry\n

\n

Audit log entry for a members_can_delete_repos.disable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MembersCanDeleteReposEnableAuditEntry\n

\n

Audit log entry for a members_can_delete_repos.enable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MentionedEvent\n

\n

Represents amentionedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MergedEvent\n

\n

Represents amergedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with the merge event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeRef (Ref)

Identifies the Ref associated with the merge event.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeRefName (String!)

Identifies the name of the Ref associated with the merge event.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this merged event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this merged event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Milestone\n

\n

Represents a Milestone object on a given repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

Identifies the actor who created the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Identifies the description of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

dueOn (DateTime)

Identifies the due date of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

issues (IssueConnection!)

A list of issues associated with the milestone.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

number (Int!)

Identifies the number of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

progressPercentage (Float!)

Identifies the percentage complete for the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests associated with the milestone.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

state (MilestoneState!)

Identifies the state of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

Identifies the title of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this milestone.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MilestoneConnection\n

\n

The connection type for Milestone.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([MilestoneEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Milestone])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MilestoneEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Milestone)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MilestonedEvent\n

\n

Represents amilestonedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneTitle (String!)

Identifies the milestone title associated with themilestonedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (MilestoneItem!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MovedColumnsInProjectEvent\n

\n

Represents amoved_columns_in_projectevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

previousProjectColumnName (String!)

Column name the issue or pull request was moved from.

\n\n\n\n\n
\n

Preview notice

\n

previousProjectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectCard (ProjectCard)

Project card referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name the issue or pull request was moved to.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OauthApplicationCreateAuditEntry\n

\n

Audit log entry for a oauth_application.create event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

applicationUrl (URI)

The application URL of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

callbackUrl (URI)

The callback URL of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

rateLimit (Int)

The rate limit of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

state (OauthApplicationCreateAuditEntryState)

The state of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgAddBillingManagerAuditEntry\n

\n

Audit log entry for a org.add_billing_manager.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationEmail (String)

The email address used to invite a billing manager for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgAddMemberAuditEntry\n

\n

Audit log entry for a org.add_member.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (OrgAddMemberAuditEntryPermission)

The permission level of the member added to the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgBlockUserAuditEntry\n

\n

Audit log entry for a org.block_user.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUser (User)

The blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserName (String)

The username of the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserResourcePath (URI)

The HTTP path for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserUrl (URI)

The HTTP URL for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgConfigDisableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a org.config.disable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgConfigEnableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a org.config.enable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgCreateAuditEntry\n

\n

Audit log entry for a org.create event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

billingPlan (OrgCreateAuditEntryBillingPlan)

The billing plan for the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgDisableOauthAppRestrictionsAuditEntry\n

\n

Audit log entry for a org.disable_oauth_app_restrictions event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgDisableSamlAuditEntry\n

\n

Audit log entry for a org.disable_saml event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

digestMethodUrl (URI)

The SAML provider's digest algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

issuerUrl (URI)

The SAML provider's issuer URL.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethodUrl (URI)

The SAML provider's signature algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

singleSignOnUrl (URI)

The SAML provider's single sign-on URL.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgDisableTwoFactorRequirementAuditEntry\n

\n

Audit log entry for a org.disable_two_factor_requirement event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgEnableOauthAppRestrictionsAuditEntry\n

\n

Audit log entry for a org.enable_oauth_app_restrictions event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgEnableSamlAuditEntry\n

\n

Audit log entry for a org.enable_saml event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

digestMethodUrl (URI)

The SAML provider's digest algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

issuerUrl (URI)

The SAML provider's issuer URL.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethodUrl (URI)

The SAML provider's signature algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

singleSignOnUrl (URI)

The SAML provider's single sign-on URL.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgEnableTwoFactorRequirementAuditEntry\n

\n

Audit log entry for a org.enable_two_factor_requirement event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgInviteMemberAuditEntry\n

\n

Audit log entry for a org.invite_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email address of the organization invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationInvitation (OrganizationInvitation)

The organization invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgInviteToBusinessAuditEntry\n

\n

Audit log entry for a org.invite_to_business event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgOauthAppAccessApprovedAuditEntry\n

\n

Audit log entry for a org.oauth_app_access_approved event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgOauthAppAccessDeniedAuditEntry\n

\n

Audit log entry for a org.oauth_app_access_denied event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgOauthAppAccessRequestedAuditEntry\n

\n

Audit log entry for a org.oauth_app_access_requested event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRemoveBillingManagerAuditEntry\n

\n

Audit log entry for a org.remove_billing_manager event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (OrgRemoveBillingManagerAuditEntryReason)

The reason for the billing manager being removed.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRemoveMemberAuditEntry\n

\n

Audit log entry for a org.remove_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

membershipTypes ([OrgRemoveMemberAuditEntryMembershipType!])

The types of membership the member has with the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (OrgRemoveMemberAuditEntryReason)

The reason for the member being removed.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRemoveOutsideCollaboratorAuditEntry\n

\n

Audit log entry for a org.remove_outside_collaborator event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

membershipTypes ([OrgRemoveOutsideCollaboratorAuditEntryMembershipType!])

The types of membership the outside collaborator has with the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (OrgRemoveOutsideCollaboratorAuditEntryReason)

The reason for the outside collaborator being removed from the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberAuditEntry\n

\n

Audit log entry for a org.restore_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredCustomEmailRoutingsCount (Int)

The number of custom email routings for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredIssueAssignmentsCount (Int)

The number of issue assignments for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredMemberships ([OrgRestoreMemberAuditEntryMembership!])

Restored organization membership objects.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredMembershipsCount (Int)

The number of restored memberships.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredRepositoriesCount (Int)

The number of repositories of the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredRepositoryStarsCount (Int)

The number of starred repositories for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredRepositoryWatchesCount (Int)

The number of watched repositories for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberMembershipOrganizationAuditEntryData\n

\n

Metadata for an organization membership for org.restore_member actions.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberMembershipRepositoryAuditEntryData\n

\n

Metadata for a repository membership for org.restore_member actions.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberMembershipTeamAuditEntryData\n

\n

Metadata for a team membership for org.restore_member actions.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUnblockUserAuditEntry\n

\n

Audit log entry for a org.unblock_user.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUser (User)

The user being unblocked by the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserName (String)

The username of the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserResourcePath (URI)

The HTTP path for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserUrl (URI)

The HTTP URL for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateDefaultRepositoryPermissionAuditEntry\n

\n

Audit log entry for a org.update_default_repository_permission.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

The new default repository permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permissionWas (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

The former default repository permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateMemberAuditEntry\n

\n

Audit log entry for a org.update_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (OrgUpdateMemberAuditEntryPermission)

The new member permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permissionWas (OrgUpdateMemberAuditEntryPermission)

The former member permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateMemberRepositoryCreationPermissionAuditEntry\n

\n

Audit log entry for a org.update_member_repository_creation_permission event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

canCreateRepositories (Boolean)

Can members create repositories in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility)

The permission for visibility level of repositories for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateMemberRepositoryInvitationPermissionAuditEntry\n

\n

Audit log entry for a org.update_member_repository_invitation_permission event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

canInviteOutsideCollaboratorsToRepositories (Boolean)

Can outside collaborators be invited to repositories in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Organization\n

\n

An account on GitHub, with one or more owners, that has repositories, members and teams.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

anyPinnableItems (Boolean!)

Determine if this repository owner has any items that can be pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

type (PinnableItemType)

\n

Filter to only a particular kind of pinnable item.

\n\n
\n\n
\n\n\n

auditLog (OrganizationAuditEntryConnection!)

Audit log entries of the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (AuditLogOrder)

\n

Ordering options for the returned audit log entries.

\n\n
\n\n
\n

query (String)

\n

The query string to filter audit entries.

\n\n
\n\n
\n\n\n

avatarUrl (URI!)

A URL pointing to the organization's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The organization's public profile description.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (String)

The organization's public profile description rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The organization's public email.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

The setting value for whether the organization has an IP allow list enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntries (IpAllowListEntryConnection!)

The IP addresses that are allowed to access resources owned by the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IpAllowListEntryOrder)

\n

Ordering options for IP allow list entries returned.

\n\n
\n\n
\n\n\n

isVerified (Boolean!)

Whether the organization has verified its profile email and website, always false on Enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

itemShowcase (ProfileItemShowcase!)

Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The organization's public profile location.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The organization's login name.

\n\n\n\n\n\n\n\n\n\n\n\n

memberStatuses (UserStatusConnection!)

Get the status messages members of this entity have set that are either public or visible only to the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (UserStatusOrder)

\n

Ordering options for user statuses returned from the connection.

\n\n
\n\n
\n\n\n

membersWithRole (OrganizationMemberConnection!)

A list of users who are members of this organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

name (String)

The organization's public profile name.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamResourcePath (URI!)

The HTTP path creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamUrl (URI!)

The HTTP URL creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationBillingEmail (String)

The billing email for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

pendingMembers (UserConnection!)

A list of users who have been invited to join this organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pinnableItems (PinnableItemConnection!)

A list of repositories and gists this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinnable items that are returned.

\n\n
\n\n
\n\n\n

pinnedItems (PinnableItemConnection!)

A list of repositories and gists this profile owner has pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinned items that are returned.

\n\n
\n\n
\n\n\n

pinnedItemsRemaining (Int!)

Returns how many more items this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Find project by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The project number to find.

\n\n
\n\n
\n\n\n

projects (ProjectConnection!)

A list of projects under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ProjectOrder)

\n

Ordering options for projects returned from the connection.

\n\n
\n\n
\n

search (String)

\n

Query to search projects by, currently only searching by name.

\n\n
\n\n
\n

states ([ProjectState!])

\n

A list of states to filter the projects by.

\n\n
\n\n
\n\n\n

projectsResourcePath (URI!)

The HTTP path listing organization's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

projectsUrl (URI!)

The HTTP URL listing organization's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (RepositoryConnection!)

A list of repositories that the user owns.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isFork (Boolean)

\n

If non-null, filters repositories according to whether they are forks of another repository.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

repository (Repository)

Find Repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

Name of Repository to find.

\n\n
\n\n
\n\n\n

requiresTwoFactorAuthentication (Boolean)

When true the organization requires all members, billing managers, and outside\ncollaborators to enable two-factor authentication.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

samlIdentityProvider (OrganizationIdentityProvider)

The Organization's SAML identity providers.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorshipsAsMaintainer (SponsorshipConnection!)

This object's sponsorships as the maintainer.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includePrivate (Boolean)

\n

Whether or not to include private sponsorships in the result set.

\n

The default value is false.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

sponsorshipsAsSponsor (SponsorshipConnection!)

This object's sponsorships as the sponsor.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

team (Team)

Find an organization's team by its slug.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

slug (String!)

\n

The name or slug of the team to find.

\n\n
\n\n
\n\n\n

teams (TeamConnection!)

A list of teams in this organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

ldapMapped (Boolean)

\n

If true, filters teams that are mapped to an LDAP Group (Enterprise only).

\n\n
\n\n
\n

orderBy (TeamOrder)

\n

Ordering options for teams returned from the connection.

\n\n
\n\n
\n

privacy (TeamPrivacy)

\n

If non-null, filters teams according to privacy.

\n\n
\n\n
\n

query (String)

\n

If non-null, filters teams with query on team name and team slug.

\n\n
\n\n
\n

role (TeamRole)

\n

If non-null, filters teams according to whether the viewer is an admin or member on team.

\n\n
\n\n
\n

rootTeamsOnly (Boolean)

\n

If true, restrict to only root teams.

\n

The default value is false.

\n
\n\n
\n

userLogins ([String!])

\n

User logins to filter by.

\n\n
\n\n
\n\n\n

teamsResourcePath (URI!)

The HTTP path listing organization's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsUrl (URI!)

The HTTP URL listing organization's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

twitterUsername (String)

The organization's Twitter username.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAdminister (Boolean!)

Organization is adminable by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanChangePinnedItems (Boolean!)

Can the viewer pin repositories and gists to the profile?.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateRepositories (Boolean!)

Viewer can create repositories on this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateTeams (Boolean!)

Viewer can create teams on this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerIsAMember (Boolean!)

Viewer is an active member of this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (URI)

The organization's public profile URL.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationAuditEntryConnection\n

\n

The connection type for OrganizationAuditEntry.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationAuditEntryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([OrganizationAuditEntry])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationAuditEntryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (OrganizationAuditEntry)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationConnection\n

\n

The connection type for Organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Organization])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Organization)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationIdentityProvider\n

\n

An Identity Provider configured to provision SAML and SCIM identities for Organizations.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

digestMethod (URI)

The digest algorithm used to sign SAML requests for the Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n\n

externalIdentities (ExternalIdentityConnection!)

External Identities provisioned by this Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

idpCertificate (X509Certificate)

The x509 certificate used by the Identity Provider to sign assertions and responses.

\n\n\n\n\n\n\n\n\n\n\n\n

issuer (String)

The Issuer Entity ID for the SAML Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

Organization this Identity Provider belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethod (URI)

The signature algorithm used to sign SAML requests for the Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n\n

ssoUrl (URI)

The URL endpoint for the Identity Provider's SAML SSO.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationInvitation\n

\n

An Invitation for a user to an organization.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email address of the user invited to the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationType (OrganizationInvitationType!)

The type of invitation that was sent (e.g. email, user).

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (User)

The user who was invited to the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

inviter (User!)

The user who created the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization!)

The organization the invite is for.

\n\n\n\n\n\n\n\n\n\n\n\n

role (OrganizationInvitationRole!)

The user's pending role in the organization (e.g. member, owner).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationInvitationConnection\n

\n

The connection type for OrganizationInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([OrganizationInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationInvitationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (OrganizationInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationMemberConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationMemberEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationMemberEdge\n

\n

Represents a user within an organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

hasTwoFactorEnabled (Boolean)

Whether the organization member has two factor enabled or not. Returns null if information is not available to viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

role (OrganizationMemberRole)

The role this user has in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationTeamsHovercardContext\n

\n

An organization teams hovercard context.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

relevantTeams (TeamConnection!)

Teams in this organization the user is a member of that are relevant.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

teamsResourcePath (URI!)

The path for the full team list for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsUrl (URI!)

The URL for the full team list for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

totalTeamCount (Int!)

The total number of teams the user is on in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationsHovercardContext\n

\n

An organization list hovercard context.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

relevantOrganizations (OrganizationConnection!)

Organizations this user is a member of that are relevant.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

totalOrganizationCount (Int!)

The total number of organizations this user is in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PageInfo\n

\n

Information about pagination in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

endCursor (String)

When paginating forwards, the cursor to continue.

\n\n\n\n\n\n\n\n\n\n\n\n

hasNextPage (Boolean!)

When paginating forwards, are there more items?.

\n\n\n\n\n\n\n\n\n\n\n\n

hasPreviousPage (Boolean!)

When paginating backwards, are there more items?.

\n\n\n\n\n\n\n\n\n\n\n\n

startCursor (String)

When paginating backwards, the cursor to continue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PermissionSource\n

\n

A level of permission and source for a user's access to a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

organization (Organization!)

The organization the repository belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (DefaultRepositoryPermissionField!)

The level of access this source has granted to the user.

\n\n\n\n\n\n\n\n\n\n\n\n

source (PermissionGranter!)

The source of this permission.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnableItemConnection\n

\n

The connection type for PinnableItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PinnableItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PinnableItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnableItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PinnableItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedEvent\n

\n

Represents apinnedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedIssue\n

\n

A Pinned Issue is a issue pinned to a repository's index page.

\n
\n\n
\n \n
\n

Preview notice

\n

PinnedIssue is available under the Pinned issues preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

The issue that was pinned.

\n\n\n\n\n\n\n\n\n\n\n\n

pinnedBy (Actor!)

The actor that pinned this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository that this issue was pinned to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedIssueConnection\n

\n

The connection type for PinnedIssue.

\n
\n\n
\n \n
\n

Preview notice

\n

PinnedIssueConnection is available under the Pinned issues preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PinnedIssueEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PinnedIssue])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedIssueEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n
\n

Preview notice

\n

PinnedIssueEdge is available under the Pinned issues preview. During the preview period, the API may change without notice.

\n
\n\n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PinnedIssue)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PrivateRepositoryForkingDisableAuditEntry\n

\n

Audit log entry for a private_repository_forking.disable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PrivateRepositoryForkingEnableAuditEntry\n

\n

Audit log entry for a private_repository_forking.enable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProfileItemShowcase\n

\n

A curatable list of repositories relating to a repository owner, which defaults\nto showing the most popular repositories they own.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

hasPinnedItems (Boolean!)

Whether or not the owner has pinned any repositories or gists.

\n\n\n\n\n\n\n\n\n\n\n\n

items (PinnableItemConnection!)

The repositories and gists in the showcase. If the profile owner has any\npinned items, those will be returned. Otherwise, the profile owner's popular\nrepositories will be returned.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Project\n

\n

Projects manage issues, pull requests and notes within a project owner.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The project's description body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The projects description body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

columns (ProjectColumnConnection!)

List of columns in the project.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

The actor who originally created the project.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The project's name.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

The project's number.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (ProjectOwner!)

The project's owner. Currently limited to repositories, organizations, and users.

\n\n\n\n\n\n\n\n\n\n\n\n

pendingCards (ProjectCardConnection!)

List of pending cards in this project.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

progress (ProjectProgress!)

Project progress details.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this project.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectState!)

Whether the project is open or closed.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this project.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectCard\n

\n

A card in a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

column (ProjectColumn)

The project column this card is associated under. A card may only belong to one\nproject column at a time. The column field will be null if the card is created\nin a pending state and has yet to be associated with a column. Once cards are\nassociated with a column, they will not become pending in the future.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ProjectCardItem)

The card content item.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

The actor who created this card.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean!)

Whether the card is archived.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The card note.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project!)

The project that contains this card.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this card.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectCardState)

The state of ProjectCard.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this card.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectCardConnection\n

\n

The connection type for ProjectCard.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ProjectCardEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ProjectCard])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectCardEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ProjectCard)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectColumn\n

\n

A column inside a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cards (ProjectCardConnection!)

List of cards in the column.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The project column's name.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project!)

The project that contains this column.

\n\n\n\n\n\n\n\n\n\n\n\n

purpose (ProjectColumnPurpose)

The semantic purpose of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this project column.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this project column.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectColumnConnection\n

\n

The connection type for ProjectColumn.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ProjectColumnEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ProjectColumn])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectColumnEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ProjectColumn)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectConnection\n

\n

A list of projects associated with the owner.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ProjectEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Project])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Project)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectProgress\n

\n

Project progress stats.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

doneCount (Int!)

The number of done cards.

\n\n\n\n\n\n\n\n\n\n\n\n

donePercentage (Float!)

The percentage of done cards.

\n\n\n\n\n\n\n\n\n\n\n\n

enabled (Boolean!)

Whether progress tracking is enabled and cards with purpose exist for this project.

\n\n\n\n\n\n\n\n\n\n\n\n

inProgressCount (Int!)

The number of in-progress cards.

\n\n\n\n\n\n\n\n\n\n\n\n

inProgressPercentage (Float!)

The percentage of in-progress cards.

\n\n\n\n\n\n\n\n\n\n\n\n

todoCount (Int!)

The number of to do cards.

\n\n\n\n\n\n\n\n\n\n\n\n

todoPercentage (Float!)

The percentage of to do cards.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PublicKey\n

\n

A user's public key.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

accessedAt (DateTime)

The last time this authorization was used to perform an action. Values will be null for keys not owned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime)

Identifies the date and time when the key was created. Keys created before\nMarch 5th, 2014 have inaccurate values. Values will be null for keys not owned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

fingerprint (String!)

The fingerprint for this PublicKey.

\n\n\n\n\n\n\n\n\n\n\n\n

isReadOnly (Boolean)

Whether this PublicKey is read-only or not. Values will be null for keys not owned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The public key string.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime)

Identifies the date and time when the key was updated. Keys created before\nMarch 5th, 2014 may have inaccurate values. Values will be null for keys not\nowned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PublicKeyConnection\n

\n

The connection type for PublicKey.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PublicKeyEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PublicKey])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PublicKeyEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PublicKey)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequest\n

\n

A repository pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

activeLockReason (LockReason)

Reason that the conversation was locked.

\n\n\n\n\n\n\n\n\n\n\n\n

additions (Int!)

The number of additions in this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

assignees (UserConnection!)

A list of Users assigned to this object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

autoMergeRequest (AutoMergeRequest)

Returns the auto-merge request object if one exists for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRef (Ref)

Identifies the base Ref associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String!)

Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefOid (GitObjectID!)

Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRepository (Repository)

The repository associated with this pull request's base Ref.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

canBeRebased (Boolean!)

Whether or not the pull request is rebaseable.

\n\n\n\n\n
\n

Preview notice

\n

canBeRebased is available under the Merge info preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

changedFiles (Int!)

The number of changed files in this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

checksResourcePath (URI!)

The HTTP path for the checks of this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

checksUrl (URI!)

The HTTP URL for the checks of this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

closed (Boolean!)

true if the pull request is closed.

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (IssueCommentConnection!)

A list of comments associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueCommentOrder)

\n

Ordering options for issue comments returned from the connection.

\n\n
\n\n
\n\n\n

commits (PullRequestCommitConnection!)

A list of commits present in this pull request's head branch not present in the base branch.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions (Int!)

The number of deletions in this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited this pull request's body.

\n\n\n\n\n\n\n\n\n\n\n\n

files (PullRequestChangedFileConnection)

Lists the files changed within this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

headRef (Ref)

Identifies the head Ref associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefOid (GitObjectID!)

Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

headRepository (Repository)

The repository associated with this pull request's head Ref.

\n\n\n\n\n\n\n\n\n\n\n\n

headRepositoryOwner (RepositoryOwner)

The owner of the repository associated with this pull request's head Ref.

\n\n\n\n\n\n\n\n\n\n\n\n

hovercard (Hovercard!)

The hovercard information for this issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

includeNotificationContexts (Boolean)

\n

Whether or not to include notification contexts.

\n

The default value is true.

\n
\n\n
\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

The head and base repositories are different.

\n\n\n\n\n\n\n\n\n\n\n\n

isDraft (Boolean!)

Identifies if the pull request is a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

isReadByViewer (Boolean)

Is this pull request read by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

labels (LabelConnection)

A list of labels associated with the object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

latestOpinionatedReviews (PullRequestReviewConnection)

A list of latest reviews per user associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

writersOnly (Boolean)

\n

Only return reviews from user who have write access to the repository.

\n

The default value is false.

\n
\n\n
\n\n\n

latestReviews (PullRequestReviewConnection)

A list of latest reviews per user associated with the pull request that are not also pending review.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

locked (Boolean!)

true if the pull request is locked.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean!)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeCommit (Commit)

The commit that was created when this pull request was merged.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeStateStatus (MergeStateStatus!)

Detailed information about the current pull request merge state status.

\n\n\n\n\n
\n

Preview notice

\n

mergeStateStatus is available under the Merge info preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

mergeable (MergeableState!)

Whether or not the pull request can be merged based on the existence of merge conflicts.

\n\n\n\n\n\n\n\n\n\n\n\n

merged (Boolean!)

Whether or not the pull request was merged.

\n\n\n\n\n\n\n\n\n\n\n\n

mergedAt (DateTime)

The date and time that the pull request was merged.

\n\n\n\n\n\n\n\n\n\n\n\n

mergedBy (Actor)

The actor who merged the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (Milestone)

Identifies the milestone associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the pull request number.

\n\n\n\n\n\n\n\n\n\n\n\n

participants (UserConnection!)

A list of Users that are participating in the Pull Request conversation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

permalink (URI!)

The permalink to the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

potentialMergeCommit (Commit)

The commit that GitHub automatically generated to test if this pull request\ncould be merged. This field will not return a value if the pull request is\nmerged, or if the test merge commit is still being generated. See the\nmergeable field for more details on the mergeability of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCards (ProjectCardConnection!)

List of project cards associated with this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

revertResourcePath (URI!)

The HTTP path for reverting this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

revertUrl (URI!)

The HTTP URL for reverting this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDecision (PullRequestReviewDecision)

The current status of this pull request with respect to code review.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewRequests (ReviewRequestConnection)

A list of review requests associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

reviewThreads (PullRequestReviewThreadConnection!)

The list of all review threads for this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

reviews (PullRequestReviewConnection)

A list of reviews associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

author (String)

\n

Filter by author of the review.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

states ([PullRequestReviewState!])

\n

A list of states to filter the reviews.

\n\n
\n\n
\n\n\n

state (PullRequestState!)

Identifies the state of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

suggestedReviewers ([SuggestedReviewer]!)

A list of reviewer suggestions based on commit history and past review comments.

\n\n\n\n\n\n\n\n\n\n\n\n

timeline (PullRequestTimelineConnection!)

A list of events, comments, commits, etc. associated with the pull request.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

timeline is deprecated.

timeline will be removed Use PullRequest.timelineItems instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Allows filtering timeline events by a since timestamp.

\n\n
\n\n
\n\n\n

timelineItems (PullRequestTimelineItemsConnection!)

A list of events, comments, commits, etc. associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

itemTypes ([PullRequestTimelineItemsItemType!])

\n

Filter timeline items by type.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Filter timeline items by a since timestamp.

\n\n
\n\n
\n

skip (Int)

\n

Skips the first n elements in the list.

\n\n
\n\n
\n\n\n

title (String!)

Identifies the pull request title.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanApplySuggestion (Boolean!)

Whether or not the viewer can apply suggestion.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanDeleteHeadRef (Boolean!)

Check if the viewer can restore the deleted head ref.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanDisableAutoMerge (Boolean!)

Whether or not the viewer can disable auto-merge.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanEnableAutoMerge (Boolean!)

Whether or not the viewer can enable auto-merge.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerMergeBodyText (String!)

The merge body text for the viewer and method.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

mergeType (PullRequestMergeMethod)

\n

The merge method for the message.

\n\n
\n\n
\n\n\n

viewerMergeHeadlineText (String!)

The merge headline text for the viewer and method.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

mergeType (PullRequestMergeMethod)

\n

The merge method for the message.

\n\n
\n\n
\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestChangedFile\n

\n

A file changed in a pull request.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

additions (Int!)

The number of additions to the file.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions (Int!)

The number of deletions to the file.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerViewedState (FileViewedState!)

The state of the file for the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestChangedFileConnection\n

\n

The connection type for PullRequestChangedFile.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestChangedFileEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestChangedFile])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestChangedFileEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestChangedFile)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommit\n

\n

Represents a Git commit part of a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commit (Commit!)

The Git commit object.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request this commit belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this pull request commit.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this pull request commit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommitCommentThread\n

\n

Represents a commit comment thread part of a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (CommitCommentConnection!)

The comments that exist in this thread.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit!)

The commit the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The file the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The position in the diff for the commit that the comment was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request this commit comment thread belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommitConnection\n

\n

The connection type for PullRequestCommit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestCommitEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestCommit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommitEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestCommit)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestConnection\n

\n

The connection type for PullRequest.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequest])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestContributionsByRepository\n

\n

This aggregates pull requests opened by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedPullRequestContributionConnection!)

The pull request contributions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the pull requests were opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequest)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReview\n

\n

A review object for a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorCanPushToRepository (Boolean!)

Indicates whether the author of this review has push access to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the pull request review body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body of this review rendered as plain text.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (PullRequestReviewCommentConnection!)

A list of review comments for the current pull request review.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit)

Identifies the commit associated with this pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

onBehalfOf (TeamConnection!)

A list of teams that this review was made on behalf of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

Identifies the pull request associated with this pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path permalink for this PullRequestReview.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestReviewState!)

Identifies the current state of the pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

submittedAt (DateTime)

Identifies when the Pull Request Review was submitted.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL permalink for this PullRequestReview.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewComment\n

\n

A review comment associated with a given repository pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The comment body of this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The comment body of this review comment rendered as plain text.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies when the comment was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

diffHunk (String!)

The diff hunk to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

draftedAt (DateTime!)

Identifies when the comment was created in a draft state.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

originalCommit (Commit)

Identifies the original commit associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

originalPosition (Int!)

The original line index in the diff to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

outdated (Boolean!)

Identifies when the comment body is outdated.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The line index in the diff to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request associated with this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReview (PullRequestReview)

The pull request review associated with this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

replyTo (PullRequestReviewComment)

The comment this is a reply to.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path permalink for this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestReviewCommentState!)

Identifies the state of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies when the comment was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL permalink for this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewCommentConnection\n

\n

The connection type for PullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestReviewCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestReviewComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestReviewComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewConnection\n

\n

The connection type for PullRequestReview.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestReviewEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestReview])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewContributionsByRepository\n

\n

This aggregates pull request reviews made by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedPullRequestReviewContributionConnection!)

The pull request review contributions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the pull request reviews were made.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestReview)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewThread\n

\n

A threaded list of comments for a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (PullRequestReviewCommentConnection!)

A list of pull request comments associated with the thread.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

skip (Int)

\n

Skips the first n elements in the list.

\n\n
\n\n
\n\n\n

diffSide (DiffSide!)

The side of the diff on which this thread was placed.

\n\n\n\n\n\n\n\n\n\n\n\n

isCollapsed (Boolean!)

Whether or not the thread has been collapsed (outdated or resolved).

\n\n\n\n\n\n\n\n\n\n\n\n

isOutdated (Boolean!)

Indicates whether this thread was outdated by newer changes.

\n\n\n\n\n\n\n\n\n\n\n\n

isResolved (Boolean!)

Whether this thread has been resolved.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int)

The line in the file to which this thread refers.

\n\n\n\n\n\n\n\n\n\n\n\n

originalLine (Int)

The original line in the file to which this thread refers.

\n\n\n\n\n\n\n\n\n\n\n\n

originalStartLine (Int)

The original start line in the file to which this thread refers (multi-line only).

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Identifies the file path of this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

Identifies the pull request associated with this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

Identifies the repository associated with this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

resolvedBy (User)

The user who resolved this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

startDiffSide (DiffSide)

The side of the diff that the first line of the thread starts on (multi-line only).

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The start line in the file to which this thread refers (multi-line only).

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReply (Boolean!)

Indicates whether the current viewer can reply to this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanResolve (Boolean!)

Whether or not the viewer can resolve this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUnresolve (Boolean!)

Whether or not the viewer can unresolve this thread.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewThreadConnection\n

\n

Review comment threads for a pull request review.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestReviewThreadEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestReviewThread])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewThreadEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestReviewThread)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestRevisionMarker\n

\n

Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

lastSeenCommit (Commit!)

The last commit the viewer has seen.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request to which the marker belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineConnection\n

\n

The connection type for PullRequestTimelineItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestTimelineItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestTimelineItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestTimelineItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineItemsConnection\n

\n

The connection type for PullRequestTimelineItems.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestTimelineItemsEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

filteredCount (Int!)

Identifies the count of items after applying before and after filters.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestTimelineItems])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageCount (Int!)

Identifies the count of items after applying before/after filters and first/last/skip slicing.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the timeline was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineItemsEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestTimelineItems)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Push\n

\n

A Git push.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

nextSha (GitObjectID)

The SHA after the push.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI!)

The permalink for this push.

\n\n\n\n\n\n\n\n\n\n\n\n

previousSha (GitObjectID)

The SHA before the push.

\n\n\n\n\n\n\n\n\n\n\n\n

pusher (User!)

The user who pushed.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository that was pushed to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PushAllowance\n

\n

A team, user or app who has the ability to push to a protected branch.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (PushAllowanceActor)

The actor that can push.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule associated with the allowed user or team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PushAllowanceConnection\n

\n

The connection type for PushAllowance.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PushAllowanceEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PushAllowance])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PushAllowanceEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PushAllowance)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RateLimit\n

\n

Represents the client's rate limit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cost (Int!)

The point cost for the current query counting against the rate limit.

\n\n\n\n\n\n\n\n\n\n\n\n

limit (Int!)

The maximum number of points the client is permitted to consume in a 60 minute window.

\n\n\n\n\n\n\n\n\n\n\n\n

nodeCount (Int!)

The maximum number of nodes this query may return.

\n\n\n\n\n\n\n\n\n\n\n\n

remaining (Int!)

The number of points remaining in the current rate limit window.

\n\n\n\n\n\n\n\n\n\n\n\n

resetAt (DateTime!)

The time at which the current rate limit window resets in UTC epoch seconds.

\n\n\n\n\n\n\n\n\n\n\n\n

used (Int!)

The number of points used in the current rate limit window.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactingUserConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReactingUserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactingUserEdge\n

\n

Represents a user that's made a reaction.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

reactedAt (DateTime!)

The moment when the user made the reaction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Reaction\n

\n

An emoji reaction to a particular piece of content.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

content (ReactionContent!)

Identifies the emoji reaction.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

reactable (Reactable!)

The reactable piece of content.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

Identifies the user who created this reaction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactionConnection\n

\n

A list of reactions that have been left on the subject.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReactionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Reaction])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasReacted (Boolean!)

Whether or not the authenticated user has left a reaction on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Reaction)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactionGroup\n

\n

A group of emoji reactions to a particular piece of content.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

content (ReactionContent!)

Identifies the emoji reaction.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime)

Identifies when the reaction was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (Reactable!)

The subject that was reacted to.

\n\n\n\n\n\n\n\n\n\n\n\n

users (ReactingUserConnection!)

Users who have reacted to the reaction subject with the emotion represented by this reaction group.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerHasReacted (Boolean!)

Whether or not the authenticated user has left a reaction on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReadyForReviewEvent\n

\n

Represents aready_for_reviewevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this ready for review event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this ready for review event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Ref\n

\n

Represents a Git reference.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

associatedPullRequests (PullRequestConnection!)

A list of pull requests with this ref as the head ref.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

branchProtectionRule (BranchProtectionRule)

Branch protection rules for this ref.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The ref name.

\n\n\n\n\n\n\n\n\n\n\n\n

prefix (String!)

The ref's prefix, such as refs/heads/ or refs/tags/.

\n\n\n\n\n\n\n\n\n\n\n\n

refUpdateRule (RefUpdateRule)

Branch protection rules that are viewable by non-admins.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository the ref belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

target (GitObject)

The object the ref points to. Returns null when object does not exist.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RefConnection\n

\n

The connection type for Ref.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RefEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Ref])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RefEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Ref)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RefUpdateRule\n

\n

A ref update rules for a viewer.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean!)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean!)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String!)

Identifies the protection rule pattern.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean!)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresSignatures (Boolean!)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanPush (Boolean!)

Can the viewer push to the branch.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReferencedEvent\n

\n

Represents areferencedevent on a given ReferencedSubject.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with thereferencedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

commitRepository (Repository!)

Identifies the repository associated with thereferencedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

isDirectReference (Boolean!)

Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (ReferencedSubject!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Release\n

\n

A release contains the content for a release.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (User)

The author of the release.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the release.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML)

The description of this release rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

isDraft (Boolean!)

Whether or not the release is a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

isLatest (Boolean!)

Whether or not the release is the latest releast.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrerelease (Boolean!)

Whether or not the release is a prerelease.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The title of the release.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies the date and time when the release was created.

\n\n\n\n\n\n\n\n\n\n\n\n

releaseAssets (ReleaseAssetConnection!)

List of releases assets which are dependent on this release.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

name (String)

\n

A list of names to filter the assets by.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository that the release belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

shortDescriptionHTML (HTML)

A description of the release, rendered to HTML without any links in it.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

limit (Int)

\n

How many characters to return.

\n

The default value is 200.

\n
\n\n
\n\n\n

tag (Ref)

The Git tag the release points to.

\n\n\n\n\n\n\n\n\n\n\n\n

tagName (String!)

The name of the release's Git tag.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseAsset\n

\n

A release asset contains the content for a release asset.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contentType (String!)

The asset's content-type.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

downloadCount (Int!)

The number of times this asset was downloaded.

\n\n\n\n\n\n\n\n\n\n\n\n

downloadUrl (URI!)

Identifies the URL where you can download the release asset via the browser.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Identifies the title of the release asset.

\n\n\n\n\n\n\n\n\n\n\n\n

release (Release)

Release that the asset is associated with.

\n\n\n\n\n\n\n\n\n\n\n\n

size (Int!)

The size (in bytes) of the asset.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

uploadedBy (User!)

The user that performed the upload.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

Identifies the URL of the release asset.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseAssetConnection\n

\n

The connection type for ReleaseAsset.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReleaseAssetEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ReleaseAsset])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseAssetEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ReleaseAsset)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseConnection\n

\n

The connection type for Release.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReleaseEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Release])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Release)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RemovedFromProjectEvent\n

\n

Represents aremoved_from_projectevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RenamedTitleEvent\n

\n

Represents arenamedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

currentTitle (String!)

Identifies the current title of the issue or pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

previousTitle (String!)

Identifies the previous title of the issue or pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (RenamedTitleSubject!)

Subject that was renamed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReopenedEvent\n

\n

Represents areopenedevent on any Closable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

closable (Closable!)

Object that was reopened.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoAccessAuditEntry\n

\n

Audit log entry for a repo.access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoAccessAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoAddMemberAuditEntry\n

\n

Audit log entry for a repo.add_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoAddMemberAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoAddTopicAuditEntry\n

\n

Audit log entry for a repo.add_topic event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topic (Topic)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicName (String)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoArchivedAuditEntry\n

\n

Audit log entry for a repo.archived event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoArchivedAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoChangeMergeSettingAuditEntry\n

\n

Audit log entry for a repo.change_merge_setting event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isEnabled (Boolean)

Whether the change was to enable (true) or disable (false) the merge type.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeType (RepoChangeMergeSettingAuditEntryMergeType)

The merge method affected by the change.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.disable_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.disable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableContributorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.disable_contributors_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableSockpuppetDisallowedAuditEntry\n

\n

Audit log entry for a repo.config.disable_sockpuppet_disallowed event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.enable_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.enable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableContributorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.enable_contributors_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableSockpuppetDisallowedAuditEntry\n

\n

Audit log entry for a repo.config.enable_sockpuppet_disallowed event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigLockAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.lock_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigUnlockAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.unlock_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoCreateAuditEntry\n

\n

Audit log entry for a repo.create event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

forkParentName (String)

The name of the parent repository for this forked repository.

\n\n\n\n\n\n\n\n\n\n\n\n

forkSourceName (String)

The name of the root repository for this network.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoCreateAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoDestroyAuditEntry\n

\n

Audit log entry for a repo.destroy event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoDestroyAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoRemoveMemberAuditEntry\n

\n

Audit log entry for a repo.remove_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoRemoveMemberAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoRemoveTopicAuditEntry\n

\n

Audit log entry for a repo.remove_topic event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topic (Topic)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicName (String)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Repository\n

\n

A repository contains the content for a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableUsers (UserConnection!)

A list of users that can be assigned to issues in this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters users with query on user name and login.

\n\n
\n\n
\n\n\n

branchProtectionRules (BranchProtectionRuleConnection!)

A list of branch protection rules for this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

codeOfConduct (CodeOfConduct)

Returns the code of conduct for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

collaborators (RepositoryCollaboratorConnection)

A list of collaborators associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliation (CollaboratorAffiliation)

\n

Collaborators affiliation level with a repository.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters users with query on user name and login.

\n\n
\n\n
\n\n\n

commitComments (CommitCommentConnection!)

A list of commit comments associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

contactLinks ([RepositoryContactLink!])

Returns a list of contact links associated to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

defaultBranchRef (Ref)

The Ref associated with the repository's default branch.

\n\n\n\n\n\n\n\n\n\n\n\n

deleteBranchOnMerge (Boolean!)

Whether or not branches are automatically deleted when merged in this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

deployKeys (DeployKeyConnection!)

A list of deploy keys that are on this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

deployments (DeploymentConnection!)

Deployments associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

environments ([String!])

\n

Environments to list deployments for.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (DeploymentOrder)

\n

Ordering options for deployments returned from the connection.

\n\n
\n\n
\n\n\n

description (String)

The description of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML!)

The description of the repository rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

diskUsage (Int)

The number of kilobytes this repository occupies on disk.

\n\n\n\n\n\n\n\n\n\n\n\n

forkCount (Int!)

Returns how many forks there are of this repository in the whole network.

\n\n\n\n\n\n\n\n\n\n\n\n

forks (RepositoryConnection!)

A list of direct forked repositories.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

hasAnonymousAccessEnabled (Boolean!)

Indicates if the repository has anonymous Git read access feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean!)

Indicates if the repository has issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasProjectsEnabled (Boolean!)

Indicates if the repository has the Projects feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean!)

Indicates if the repository has wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The repository's URL.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean!)

Indicates if the repository is unmaintained.

\n\n\n\n\n\n\n\n\n\n\n\n

isBlankIssuesEnabled (Boolean!)

Returns true if blank issue creation is allowed.

\n\n\n\n\n\n\n\n\n\n\n\n

isDisabled (Boolean!)

Returns whether or not this repository disabled.

\n\n\n\n\n\n\n\n\n\n\n\n

isEmpty (Boolean!)

Returns whether or not this repository is empty.

\n\n\n\n\n\n\n\n\n\n\n\n

isFork (Boolean!)

Identifies if the repository is a fork.

\n\n\n\n\n\n\n\n\n\n\n\n

isInOrganization (Boolean!)

Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.

\n\n\n\n\n\n\n\n\n\n\n\n

isLocked (Boolean!)

Indicates if the repository has been locked or not.

\n\n\n\n\n\n\n\n\n\n\n\n

isMirror (Boolean!)

Identifies if the repository is a mirror.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrivate (Boolean!)

Identifies if the repository is private.

\n\n\n\n\n\n\n\n\n\n\n\n

isSecurityPolicyEnabled (Boolean)

Returns true if this repository has a security policy.

\n\n\n\n\n\n\n\n\n\n\n\n

isTemplate (Boolean!)

Identifies if the repository is a template that can be used to generate new repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

isUserConfigurationRepository (Boolean!)

Is this repository a user configuration repository?.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue)

Returns a single issue from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the issue to be returned.

\n\n
\n\n
\n\n\n

issueOrPullRequest (IssueOrPullRequest)

Returns a single issue-like object from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the issue to be returned.

\n\n
\n\n
\n\n\n

issueTemplates ([IssueTemplate!])

Returns a list of issue templates associated to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

issues (IssueConnection!)

A list of issues that have been opened in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

label (Label)

Returns a single label by name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

Label name.

\n\n
\n\n
\n\n\n

labels (LabelConnection)

A list of labels associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n

query (String)

\n

If provided, searches labels by name and description.

\n\n
\n\n
\n\n\n

languages (LanguageConnection)

A list containing a breakdown of the language composition of the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LanguageOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

latestRelease (Release)

Get the latest release for the repository if one exists.

\n\n\n\n\n\n\n\n\n\n\n\n

licenseInfo (License)

The license associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (RepositoryLockReason)

The reason the repository has been locked.

\n\n\n\n\n\n\n\n\n\n\n\n

mentionableUsers (UserConnection!)

A list of Users that can be mentioned in the context of the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters users with query on user name and login.

\n\n
\n\n
\n\n\n

mergeCommitAllowed (Boolean!)

Whether or not PRs are merged with a merge commit on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (Milestone)

Returns a single milestone from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the milestone to be returned.

\n\n
\n\n
\n\n\n

milestones (MilestoneConnection)

A list of milestones associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (MilestoneOrder)

\n

Ordering options for milestones.

\n\n
\n\n
\n

query (String)

\n

Filters milestones with a query on the title.

\n\n
\n\n
\n

states ([MilestoneState!])

\n

Filter by the state of the milestones.

\n\n
\n\n
\n\n\n

mirrorUrl (URI)

The repository's original mirror URL.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

nameWithOwner (String!)

The repository's name with owner.

\n\n\n\n\n\n\n\n\n\n\n\n

object (GitObject)

A Git object in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

expression (String)

\n

A Git revision expression suitable for rev-parse.

\n\n
\n\n
\n

oid (GitObjectID)

\n

The Git object ID.

\n\n
\n\n
\n\n\n

openGraphImageUrl (URI!)

The image used to represent this repository in Open Graph data.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (RepositoryOwner!)

The User owner of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

parent (Repository)

The repository parent, if this is a fork.

\n\n\n\n\n\n\n\n\n\n\n\n

pinnedIssues (PinnedIssueConnection)

A list of pinned issues for this repository.

\n\n\n\n\n
\n

Preview notice

\n

pinnedIssues is available under the Pinned issues preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

primaryLanguage (Language)

The primary language of the repository's code.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Find project by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The project number to find.

\n\n
\n\n
\n\n\n

projects (ProjectConnection!)

A list of projects under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ProjectOrder)

\n

Ordering options for projects returned from the connection.

\n\n
\n\n
\n

search (String)

\n

Query to search projects by, currently only searching by name.

\n\n
\n\n
\n

states ([ProjectState!])

\n

A list of states to filter the projects by.

\n\n
\n\n
\n\n\n

projectsResourcePath (URI!)

The HTTP path listing the repository's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

projectsUrl (URI!)

The HTTP URL listing the repository's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

Returns a single pull request from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the pull request to be returned.

\n\n
\n\n
\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests that have been opened in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

pushedAt (DateTime)

Identifies when the repository was last pushed to.

\n\n\n\n\n\n\n\n\n\n\n\n

rebaseMergeAllowed (Boolean!)

Whether or not rebase-merging is enabled on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Fetch a given ref from the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

qualifiedName (String!)

\n

The ref to retrieve. Fully qualified matches are checked in order\n(refs/heads/master) before falling back onto checks for short name matches (master).

\n\n
\n\n
\n\n\n

refs (RefConnection)

Fetch a list of refs from the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

direction (OrderDirection)

\n

DEPRECATED: use orderBy. The ordering direction.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RefOrder)

\n

Ordering options for refs returned from the connection.

\n\n
\n\n
\n

query (String)

\n

Filters refs with query on name.

\n\n
\n\n
\n

refPrefix (String!)

\n

A ref name prefix like refs/heads/, refs/tags/, etc.

\n\n
\n\n
\n\n\n

release (Release)

Lookup a single release given various criteria.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

tagName (String!)

\n

The name of the Tag the Release was created from.

\n\n
\n\n
\n\n\n

releases (ReleaseConnection!)

List of releases which are dependent on this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReleaseOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

repositoryTopics (RepositoryTopicConnection!)

A list of applied repository-topic associations for this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

securityPolicyUrl (URI)

The security policy URL.

\n\n\n\n\n\n\n\n\n\n\n\n

shortDescriptionHTML (HTML!)

A description of the repository, rendered to HTML without any links in it.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

limit (Int)

\n

How many characters to return.

\n

The default value is 200.

\n
\n\n
\n\n\n

squashMergeAllowed (Boolean!)

Whether or not squash-merging is enabled on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

sshUrl (GitSSHRemote!)

The SSH URL to clone this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

submodules (SubmoduleConnection!)

Returns a list of all submodules in this repository parsed from the\n.gitmodules file as of the default branch's HEAD commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

tempCloneToken (String)

Temporary authentication token for cloning this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

templateRepository (Repository)

The repository from which this repository was generated, if any.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

usesCustomOpenGraphImage (Boolean!)

Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAdminister (Boolean!)

Indicates whether the viewer has admin permissions on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdateTopics (Boolean!)

Indicates whether the viewer can update the topics of this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDefaultCommitEmail (String)

The last commit email for the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDefaultMergeMethod (PullRequestMergeMethod!)

The last used merge method by the viewer or the default for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerPermission (RepositoryPermission)

The users permission level on the repository. Will return null if authenticated as an GitHub App.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerPossibleCommitEmails ([String!])

A list of emails this viewer can commit with.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerabilityAlerts (RepositoryVulnerabilityAlertConnection)

A list of vulnerability alerts that are on this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

watchers (UserConnection!)

A list of users watching the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryCollaboratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryCollaboratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryCollaboratorEdge\n

\n

Represents a user who is a collaborator of a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (RepositoryPermission!)

The permission the user has on the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

permissionSources ([PermissionSource!])

A list of sources for the user's access to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryConnection\n

\n

A list of repositories owned by the subject.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Repository])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalDiskUsage (Int!)

The total size in kilobytes of all repositories in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryContactLink\n

\n

A repository contact link.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

about (String!)

The contact link purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The contact link name.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The contact link URL.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Repository)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInvitation\n

\n

An invitation for a user to be added to a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String)

The email address that received the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (User)

The user who received the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

inviter (User!)

The user who created the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI!)

The permalink for this repository invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (RepositoryPermission!)

The permission granted on this repository by this invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (RepositoryInfo)

The Repository the user is invited to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationConnection\n

\n

The connection type for RepositoryInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([RepositoryInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (RepositoryInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryTopic\n

\n

A repository-topic connects a repository to a topic.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

resourcePath (URI!)

The HTTP path for this repository-topic.

\n\n\n\n\n\n\n\n\n\n\n\n

topic (Topic!)

The topic.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this repository-topic.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryTopicConnection\n

\n

The connection type for RepositoryTopic.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryTopicEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([RepositoryTopic])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryTopicEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (RepositoryTopic)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVisibilityChangeDisableAuditEntry\n

\n

Audit log entry for a repository_visibility_change.disable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVisibilityChangeEnableAuditEntry\n

\n

Audit log entry for a repository_visibility_change.enable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVulnerabilityAlert\n

\n

A alert for a repository with an affected vulnerability.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

When was the alert created?.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissReason (String)

The reason the alert was dismissed.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissedAt (DateTime)

When was the alert dismissed?.

\n\n\n\n\n\n\n\n\n\n\n\n

dismisser (User)

The user who dismissed the alert.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The associated repository.

\n\n\n\n\n\n\n\n\n\n\n\n

securityAdvisory (SecurityAdvisory)

The associated security advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

securityVulnerability (SecurityVulnerability)

The associated security vulnerability.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableManifestFilename (String!)

The vulnerable manifest filename.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableManifestPath (String!)

The vulnerable manifest path.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableRequirements (String)

The vulnerable requirements.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVulnerabilityAlertConnection\n

\n

The connection type for RepositoryVulnerabilityAlert.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryVulnerabilityAlertEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([RepositoryVulnerabilityAlert])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVulnerabilityAlertEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (RepositoryVulnerabilityAlert)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RestrictedContribution\n

\n

Represents a private contribution a user made on GitHub.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissalAllowance\n

\n

A team or user who has the ability to dismiss a review on a protected branch.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (ReviewDismissalAllowanceActor)

The actor that can dismiss.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule associated with the allowed user or team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissalAllowanceConnection\n

\n

The connection type for ReviewDismissalAllowance.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReviewDismissalAllowanceEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ReviewDismissalAllowance])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissalAllowanceEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ReviewDismissalAllowance)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissedEvent\n

\n

Represents areview_dismissedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissalMessage (String)

Identifies the optional message associated with thereview_dismissedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissalMessageHTML (String)

Identifies the optional message associated with the event, rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

previousReviewState (PullRequestReviewState!)

Identifies the previous state of the review with thereview_dismissedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestCommit (PullRequestCommit)

Identifies the commit which caused the review to become stale.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this review dismissed event.

\n\n\n\n\n\n\n\n\n\n\n\n

review (PullRequestReview)

Identifies the review associated with thereview_dismissedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this review dismissed event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequest\n

\n

A request for a user to review a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

asCodeOwner (Boolean!)

Whether this request was created for a code owner.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

Identifies the pull request associated with this review request.

\n\n\n\n\n\n\n\n\n\n\n\n

requestedReviewer (RequestedReviewer)

The reviewer that is requested.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestConnection\n

\n

The connection type for ReviewRequest.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReviewRequestEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ReviewRequest])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ReviewRequest)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestRemovedEvent\n

\n

Represents anreview_request_removedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

requestedReviewer (RequestedReviewer)

Identifies the reviewer whose review request was removed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestedEvent\n

\n

Represents anreview_requestedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

requestedReviewer (RequestedReviewer)

Identifies the reviewer whose review was requested.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewStatusHovercardContext\n

\n

A hovercard context with a message describing the current code review state of the pull\nrequest.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDecision (PullRequestReviewDecision)

The current status of the pull request with respect to code review.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SavedReply\n

\n

A Saved Reply is text a user can use to reply quickly.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the saved reply.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The saved reply body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the saved reply.

\n\n\n\n\n\n\n\n\n\n\n\n

user (Actor)

The user that saved this reply.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SavedReplyConnection\n

\n

The connection type for SavedReply.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SavedReplyEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SavedReply])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SavedReplyEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SavedReply)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SearchResultItemConnection\n

\n

A list of results that matched against a search query.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

codeCount (Int!)

The number of pieces of code that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

edges ([SearchResultItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

issueCount (Int!)

The number of issues that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SearchResultItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryCount (Int!)

The number of repositories that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

userCount (Int!)

The number of users that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

wikiCount (Int!)

The number of wiki pages that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SearchResultItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SearchResultItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

textMatches ([TextMatch])

Text matches on the result found.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisory\n

\n

A GitHub Security Advisory.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cvss (CVSS!)

The CVSS associated with this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

cwes (CWEConnection!)

CWEs associated with this Advisory.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String!)

This is a long plaintext description of the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

ghsaId (String!)

The GitHub Security Advisory ID.

\n\n\n\n\n\n\n\n\n\n\n\n

identifiers ([SecurityAdvisoryIdentifier!]!)

A list of identifiers for this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

notificationsPermalink (URI)

The permalink for the advisory's dependabot alerts page.

\n\n\n\n\n\n\n\n\n\n\n\n

origin (String!)

The organization that originated the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI)

The permalink for the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime!)

When the advisory was published.

\n\n\n\n\n\n\n\n\n\n\n\n

references ([SecurityAdvisoryReference!]!)

A list of references for this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

severity (SecurityAdvisorySeverity!)

The severity of the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String!)

A short plaintext summary of the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

When the advisory was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerabilities (SecurityVulnerabilityConnection!)

Vulnerabilities associated with this Advisory.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

ecosystem (SecurityAdvisoryEcosystem)

\n

An ecosystem to filter vulnerabilities by.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

package (String)

\n

A package name to filter vulnerabilities by.

\n\n
\n\n
\n

severities ([SecurityAdvisorySeverity!])

\n

A list of severities to filter vulnerabilities by.

\n\n
\n\n
\n\n\n

withdrawnAt (DateTime)

When the advisory was withdrawn, if it has been withdrawn.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryConnection\n

\n

The connection type for SecurityAdvisory.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SecurityAdvisoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SecurityAdvisory])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SecurityAdvisory)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryIdentifier\n

\n

A GitHub Security Advisory Identifier.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

type (String!)

The identifier type, e.g. GHSA, CVE.

\n\n\n\n\n\n\n\n\n\n\n\n

value (String!)

The identifier.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryPackage\n

\n

An individual package.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

ecosystem (SecurityAdvisoryEcosystem!)

The ecosystem the package belongs to, e.g. RUBYGEMS, NPM.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The package name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryPackageVersion\n

\n

An individual package version.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

identifier (String!)

The package name or version.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryReference\n

\n

A GitHub Security Advisory Reference.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

url (URI!)

A publicly accessible reference.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityVulnerability\n

\n

An individual vulnerability within an Advisory.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

advisory (SecurityAdvisory!)

The Advisory associated with this Vulnerability.

\n\n\n\n\n\n\n\n\n\n\n\n

firstPatchedVersion (SecurityAdvisoryPackageVersion)

The first version containing a fix for the vulnerability.

\n\n\n\n\n\n\n\n\n\n\n\n

package (SecurityAdvisoryPackage!)

A description of the vulnerable package.

\n\n\n\n\n\n\n\n\n\n\n\n

severity (SecurityAdvisorySeverity!)

The severity of the vulnerability within this package.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

When the vulnerability was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableVersionRange (String!)

A string that describes the vulnerable package versions.\nThis string follows a basic syntax with a few forms.

\n
    \n
  • = 0.2.0 denotes a single vulnerable version.
    • \n
  • <= 1.0.8 denotes a version range up to and including the specified version
    • \n
  • < 0.1.11 denotes a version range up to, but excluding, the specified version
    • \n
  • >= 4.3.0, < 4.3.5 denotes a version range with a known minimum and maximum version.
    • \n
  • >= 0.0.1 denotes a version range with a known minimum, but no known maximum.
    • \n

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityVulnerabilityConnection\n

\n

The connection type for SecurityVulnerability.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SecurityVulnerabilityEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SecurityVulnerability])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityVulnerabilityEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SecurityVulnerability)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SmimeSignature\n

\n

Represents an S/MIME signature on a Commit or Tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String!)

Email used to sign this object.

\n\n\n\n\n\n\n\n\n\n\n\n

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (String!)

ASCII-armored signature header from object.

\n\n\n\n\n\n\n\n\n\n\n\n

signer (User)

GitHub user corresponding to the email signing this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

\n\n\n\n\n\n\n\n\n\n\n\n

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Sponsorship\n

\n

A sponsorship relationship between a sponsor and a maintainer.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainer (User!)

The entity that is being sponsored.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

maintainer is deprecated.

Sponsorship.maintainer will be removed. Use Sponsorship.sponsorable instead. Removal on 2020-04-01 UTC.

\n
\n\n\n\n\n\n\n

privacyLevel (SponsorshipPrivacy!)

The privacy level for this sponsorship.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsor (User)

The user that is sponsoring. Returns null if the sponsorship is private or if sponsor is not a user.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

sponsor is deprecated.

Sponsorship.sponsor will be removed. Use Sponsorship.sponsorEntity instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n\n

sponsorEntity (Sponsor)

The user or organization that is sponsoring, if you have permission to view them.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorable (Sponsorable!)

The entity that is being sponsored.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorshipConnection\n

\n

The connection type for Sponsorship.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SponsorshipEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Sponsorship])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorshipEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Sponsorship)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StargazerConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([StargazerEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StargazerEdge\n

\n

Represents a user that's starred a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

starredAt (DateTime!)

Identifies when the item was starred.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StarredRepositoryConnection\n

\n

The connection type for Repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([StarredRepositoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

isOverLimit (Boolean!)

Is the list of stars for this user truncated? This is true for users that have many stars.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Repository])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StarredRepositoryEdge\n

\n

Represents a starred repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

starredAt (DateTime!)

Identifies when the item was starred.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Status\n

\n

Represents a commit status.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

combinedContexts (StatusCheckRollupContextConnection!)

A list of status contexts and check runs for this commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit)

The commit this status is attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

context (StatusContext)

Looks up an individual status context by context name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

The context name.

\n\n
\n\n
\n\n\n

contexts ([StatusContext!]!)

The individual status contexts for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (StatusState!)

The combined commit status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusCheckRollup\n

\n

Represents the rollup for both the check runs and status for a commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commit (Commit)

The commit the status and check runs are attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

contexts (StatusCheckRollupContextConnection!)

A list of status contexts and check runs for this commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

state (StatusState!)

The combined status for the commit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusCheckRollupContextConnection\n

\n

The connection type for StatusCheckRollupContext.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([StatusCheckRollupContextEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([StatusCheckRollupContext])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusCheckRollupContextEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (StatusCheckRollupContext)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusContext\n

\n

Represents an individual commit status context.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI)

The avatar of the OAuth application or the user that created the status.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n

The default value is 40.

\n
\n\n
\n\n\n

commit (Commit)

This commit this status context is attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

context (String!)

The name of this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

The actor who created this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description for this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

state (StatusState!)

The state of this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

targetUrl (URI)

The URL for this status context.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Submodule\n

\n

A pointer to a repository at a specific revision embedded inside another repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branch (String)

The branch of the upstream submodule for tracking updates.

\n\n\n\n\n\n\n\n\n\n\n\n

gitUrl (URI!)

The git URL of the submodule repository.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the submodule in .gitmodules.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path in the superproject that this submodule is located in.

\n\n\n\n\n\n\n\n\n\n\n\n

subprojectCommitOid (GitObjectID)

The commit revision of the subproject repository being tracked by the submodule.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SubmoduleConnection\n

\n

The connection type for Submodule.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SubmoduleEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Submodule])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SubmoduleEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Submodule)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SubscribedEvent\n

\n

Represents asubscribedevent on a given Subscribable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribable (Subscribable!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SuggestedReviewer\n

\n

A suggestion to review a pull request based on a user's commit history and review comments.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isAuthor (Boolean!)

Is this suggestion based on past commits?.

\n\n\n\n\n\n\n\n\n\n\n\n

isCommenter (Boolean!)

Is this suggestion based on past review comments?.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewer (User!)

Identifies the user suggested to review the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Tag\n

\n

Represents a Git tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

The Git tag message.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The Git tag name.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the Git object belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

tagger (GitActor)

Details about the tag author.

\n\n\n\n\n\n\n\n\n\n\n\n

target (GitObject!)

The Git object the tag points to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Team\n

\n

A team of users in an organization.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

ancestors (TeamConnection!)

A list of teams that are ancestors of this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

avatarUrl (URI)

A URL pointing to the team's avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size in pixels of the resulting square image.

\n

The default value is 400.

\n
\n\n
\n\n\n

childTeams (TeamConnection!)

List of child teams belonging to this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

immediateOnly (Boolean)

\n

Whether to list immediate child teams or all descendant child teams.

\n

The default value is true.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamOrder)

\n

Order for connection.

\n\n
\n\n
\n

userLogins ([String!])

\n

User logins to filter by.

\n\n
\n\n
\n\n\n

combinedSlug (String!)

The slug corresponding to the organization and team.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

discussion (TeamDiscussion)

Find a team discussion by its number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The sequence number of the discussion to find.

\n\n
\n\n
\n\n\n

discussions (TeamDiscussionConnection!)

A list of team discussions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isPinned (Boolean)

\n

If provided, filters discussions according to whether or not they are pinned.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamDiscussionOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

discussionsResourcePath (URI!)

The HTTP path for team discussions.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionsUrl (URI!)

The HTTP URL for team discussions.

\n\n\n\n\n\n\n\n\n\n\n\n

editTeamResourcePath (URI!)

The HTTP path for editing this team.

\n\n\n\n\n\n\n\n\n\n\n\n

editTeamUrl (URI!)

The HTTP URL for editing this team.

\n\n\n\n\n\n\n\n\n\n\n\n

invitations (OrganizationInvitationConnection)

A list of pending invitations for users to this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

memberStatuses (UserStatusConnection!)

Get the status messages members of this entity have set that are either public or visible only to the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (UserStatusOrder)

\n

Ordering options for user statuses returned from the connection.

\n\n
\n\n
\n\n\n

members (TeamMemberConnection!)

A list of users who are members of this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

membership (TeamMembershipType)

\n

Filter by membership type.

\n

The default value is ALL.

\n
\n\n
\n

orderBy (TeamMemberOrder)

\n

Order for the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (TeamMemberRole)

\n

Filter by team member role.

\n\n
\n\n
\n\n\n

membersResourcePath (URI!)

The HTTP path for the team' members.

\n\n\n\n\n\n\n\n\n\n\n\n

membersUrl (URI!)

The HTTP URL for the team' members.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamResourcePath (URI!)

The HTTP path creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamUrl (URI!)

The HTTP URL creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization!)

The organization that owns this team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeam (Team)

The parent team of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

privacy (TeamPrivacy!)

The level of privacy the team has.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (TeamRepositoryConnection!)

A list of repositories this team has access to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamRepositoryOrder)

\n

Order for the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

repositoriesResourcePath (URI!)

The HTTP path for this team's repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoriesUrl (URI!)

The HTTP URL for this team's repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewRequestDelegationAlgorithm (TeamReviewAssignmentAlgorithm)

What algorithm is used for review assignment for this team.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationAlgorithm is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

reviewRequestDelegationEnabled (Boolean!)

True if review assignment is enabled for this team.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationEnabled is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

reviewRequestDelegationMemberCount (Int)

How many team members are required for review assignment for this team.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationMemberCount is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

reviewRequestDelegationNotifyTeam (Boolean!)

When assigning team members via delegation, whether the entire team should be notified as well.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationNotifyTeam is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

slug (String!)

The slug corresponding to the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsResourcePath (URI!)

The HTTP path for this team's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsUrl (URI!)

The HTTP URL for this team's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAdminister (Boolean!)

Team is adminable by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamAddMemberAuditEntry\n

\n

Audit log entry for a team.add_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamAddRepositoryAuditEntry\n

\n

Audit log entry for a team.add_repository event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamChangeParentTeamAuditEntry\n

\n

Audit log entry for a team.change_parent_team event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeam (Team)

The new parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamName (String)

The name of the new parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamNameWas (String)

The name of the former parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamResourcePath (URI)

The HTTP path for the parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamUrl (URI)

The HTTP URL for the parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamWas (Team)

The former parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamWasResourcePath (URI)

The HTTP path for the previous parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamWasUrl (URI)

The HTTP URL for the previous parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamConnection\n

\n

The connection type for Team.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Team])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussion\n

\n

A team discussion.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the discussion's team.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String!)

Identifies the discussion body hash.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (TeamDiscussionCommentConnection!)

A list of comments on this discussion.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

fromComment (Int)

\n

When provided, filters the connection such that results begin with the comment with this number.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamDiscussionCommentOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

commentsResourcePath (URI!)

The HTTP path for discussion comments.

\n\n\n\n\n\n\n\n\n\n\n\n

commentsUrl (URI!)

The HTTP URL for discussion comments.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isPinned (Boolean!)

Whether or not the discussion is pinned.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrivate (Boolean!)

Whether or not the discussion is only visible to team members and org admins.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the discussion within its team.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team!)

The team that defines the context of this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanPin (Boolean!)

Whether or not the current viewer can pin this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionComment\n

\n

A comment on a team discussion.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the comment's team.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String!)

The current version of the body content.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

discussion (TeamDiscussion!)

The discussion this comment is about.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the comment number.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentConnection\n

\n

The connection type for TeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamDiscussionCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([TeamDiscussionComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (TeamDiscussionComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionConnection\n

\n

The connection type for TeamDiscussion.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamDiscussionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([TeamDiscussion])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (TeamDiscussion)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Team)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamMemberConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamMemberEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamMemberEdge\n

\n

Represents a user who is a member of a team.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

memberAccessResourcePath (URI!)

The HTTP path to the organization's member access page.

\n\n\n\n\n\n\n\n\n\n\n\n

memberAccessUrl (URI!)

The HTTP URL to the organization's member access page.

\n\n\n\n\n\n\n\n\n\n\n\n

role (TeamMemberRole!)

The role the member has on the team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRemoveMemberAuditEntry\n

\n

Audit log entry for a team.remove_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRemoveRepositoryAuditEntry\n

\n

Audit log entry for a team.remove_repository event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRepositoryConnection\n

\n

The connection type for Repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamRepositoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Repository])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRepositoryEdge\n

\n

Represents a team repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (RepositoryPermission!)

The permission level the team has on the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TextMatch\n

\n

A text match within a search result.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

fragment (String!)

The specific text fragment within the property matched on.

\n\n\n\n\n\n\n\n\n\n\n\n

highlights ([TextMatchHighlight!]!)

Highlights within the matched fragment.

\n\n\n\n\n\n\n\n\n\n\n\n

property (String!)

The property matched on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TextMatchHighlight\n

\n

Represents a single highlight in a search result match.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

beginIndice (Int!)

The indice in the fragment where the matched text begins.

\n\n\n\n\n\n\n\n\n\n\n\n

endIndice (Int!)

The indice in the fragment where the matched text ends.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String!)

The text matched.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Topic\n

\n

A topic aggregates entities that are related to a subject.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

name (String!)

The topic's name.

\n\n\n\n\n\n\n\n\n\n\n\n

relatedTopics ([Topic!]!)

A list of related topics, including aliases of this topic, sorted with the most relevant\nfirst. Returns up to 10 Topics.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

first (Int)

\n

How many topics to return.

\n

The default value is 3.

\n
\n\n
\n\n\n

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TransferredEvent\n

\n

Represents atransferredevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

fromRepository (Repository)

The repository this came from.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Tree\n

\n

Represents a Git tree.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

entries ([TreeEntry!])

A list of tree entries.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the Git object belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TreeEntry\n

\n

Represents a Git tree entry.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

extension (String)

The extension of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

isGenerated (Boolean!)

Whether or not this tree entry is generated.

\n\n\n\n\n\n\n\n\n\n\n\n

mode (Int!)

Entry file mode.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Entry file name.

\n\n\n\n\n\n\n\n\n\n\n\n

object (GitObject)

Entry file object.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

Entry file Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The full path of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the tree entry belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

submodule (Submodule)

If the TreeEntry is for a directory occupied by a submodule project, this returns the corresponding submodule.

\n\n\n\n\n\n\n\n\n\n\n\n

type (String!)

Entry file type.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnassignedEvent\n

\n

Represents anunassignedevent on any assignable object.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignable (Assignable!)

Identifies the assignable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignee (Assignee)

Identifies the user or mannequin that was unassigned.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

Identifies the subject (user) who was unassigned.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

user is deprecated.

Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnknownSignature\n

\n

Represents an unknown signature on a Commit or Tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String!)

Email used to sign this object.

\n\n\n\n\n\n\n\n\n\n\n\n

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (String!)

ASCII-armored signature header from object.

\n\n\n\n\n\n\n\n\n\n\n\n

signer (User)

GitHub user corresponding to the email signing this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

\n\n\n\n\n\n\n\n\n\n\n\n

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnlabeledEvent\n

\n

Represents anunlabeledevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

label (Label!)

Identifies the label associated with theunlabeledevent.

\n\n\n\n\n\n\n\n\n\n\n\n

labelable (Labelable!)

Identifies the Labelable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnlockedEvent\n

\n

Represents anunlockedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

lockable (Lockable!)

Object that was unlocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnmarkedAsDuplicateEvent\n

\n

Represents anunmarked_as_duplicateevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

canonical (IssueOrPullRequest)

The authoritative issue or pull request which has been duplicated by another.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicate (IssueOrPullRequest)

The issue or pull request which has been marked as a duplicate of another.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Canonical and duplicate belong to different repositories.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnpinnedEvent\n

\n

Represents anunpinnedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnsubscribedEvent\n

\n

Represents anunsubscribedevent on a given Subscribable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribable (Subscribable!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n User\n

\n

A user is an individual's account on GitHub that owns repositories and can make new content.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

anyPinnableItems (Boolean!)

Determine if this repository owner has any items that can be pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

type (PinnableItemType)

\n

Filter to only a particular kind of pinnable item.

\n\n
\n\n
\n\n\n

avatarUrl (URI!)

A URL pointing to the user's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

bio (String)

The user's public profile bio.

\n\n\n\n\n\n\n\n\n\n\n\n

bioHTML (HTML!)

The user's public profile bio as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

commitComments (CommitCommentConnection!)

A list of commit comments made by this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

company (String)

The user's public profile company.

\n\n\n\n\n\n\n\n\n\n\n\n

companyHTML (HTML!)

The user's public profile company as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionsCollection (ContributionsCollection!)

The collection of contributions this user has made to different repositories.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

from (DateTime)

\n

Only contributions made at this time or later will be counted. If omitted, defaults to a year ago.

\n\n
\n\n
\n

organizationID (ID)

\n

The ID of the organization used to filter contributions.

\n\n
\n\n
\n

to (DateTime)

\n

Only contributions made before and up to and including this time will be\ncounted. If omitted, defaults to the current time.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String!)

The user's publicly visible profile email.

\n\n\n\n\n\n\n\n\n\n\n\n

followers (FollowerConnection!)

A list of users the given user is followed by.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

following (FollowingConnection!)

A list of users the given user is following.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

gist (Gist)

Find gist by repo name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

The gist name to find.

\n\n
\n\n
\n\n\n

gistComments (GistCommentConnection!)

A list of gist comments made by this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

gists (GistConnection!)

A list of the Gists the user has created.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (GistOrder)

\n

Ordering options for gists returned from the connection.

\n\n
\n\n
\n

privacy (GistPrivacy)

\n

Filters Gists according to privacy.

\n\n
\n\n
\n\n\n

hovercard (Hovercard!)

The hovercard information for this user in a given context.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

primarySubjectId (ID)

\n

The ID of the subject to get the hovercard in the context of.

\n\n
\n\n
\n\n\n

isBountyHunter (Boolean!)

Whether or not this user is a participant in the GitHub Security Bug Bounty.

\n\n\n\n\n\n\n\n\n\n\n\n

isCampusExpert (Boolean!)

Whether or not this user is a participant in the GitHub Campus Experts Program.

\n\n\n\n\n\n\n\n\n\n\n\n

isDeveloperProgramMember (Boolean!)

Whether or not this user is a GitHub Developer Program member.

\n\n\n\n\n\n\n\n\n\n\n\n

isEmployee (Boolean!)

Whether or not this user is a GitHub employee.

\n\n\n\n\n\n\n\n\n\n\n\n

isHireable (Boolean!)

Whether or not the user has marked themselves as for hire.

\n\n\n\n\n\n\n\n\n\n\n\n

isSiteAdmin (Boolean!)

Whether or not this user is a site administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

isViewer (Boolean!)

Whether or not this user is the viewing user.

\n\n\n\n\n\n\n\n\n\n\n\n

issueComments (IssueCommentConnection!)

A list of issue comments made by this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueCommentOrder)

\n

Ordering options for issue comments returned from the connection.

\n\n
\n\n
\n\n\n

issues (IssueConnection!)

A list of issues associated with this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

itemShowcase (ProfileItemShowcase!)

Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The user's public profile location.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The username used to login.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The user's public profile name.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

Find an organization by its login that the user belongs to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

login (String!)

\n

The login of the organization to find.

\n\n
\n\n
\n\n\n

organizationVerifiedDomainEmails ([String!]!)

Verified email addresses that match verified domains for a specified organization the user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

login (String!)

\n

The login of the organization to match verified domains from.

\n\n
\n\n
\n\n\n

organizations (OrganizationConnection!)

A list of organizations the user belongs to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pinnableItems (PinnableItemConnection!)

A list of repositories and gists this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinnable items that are returned.

\n\n
\n\n
\n\n\n

pinnedItems (PinnableItemConnection!)

A list of repositories and gists this profile owner has pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinned items that are returned.

\n\n
\n\n
\n\n\n

pinnedItemsRemaining (Int!)

Returns how many more items this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Find project by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The project number to find.

\n\n
\n\n
\n\n\n

projects (ProjectConnection!)

A list of projects under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ProjectOrder)

\n

Ordering options for projects returned from the connection.

\n\n
\n\n
\n

search (String)

\n

Query to search projects by, currently only searching by name.

\n\n
\n\n
\n

states ([ProjectState!])

\n

A list of states to filter the projects by.

\n\n
\n\n
\n\n\n

projectsResourcePath (URI!)

The HTTP path listing user's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

projectsUrl (URI!)

The HTTP URL listing user's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

publicKeys (PublicKeyConnection!)

A list of public keys associated with this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests associated with this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

repositories (RepositoryConnection!)

A list of repositories that the user owns.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isFork (Boolean)

\n

If non-null, filters repositories according to whether they are forks of another repository.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

repositoriesContributedTo (RepositoryConnection!)

A list of repositories that the user recently contributed to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

contributionTypes ([RepositoryContributionType])

\n

If non-null, include only the specified types of contributions. The\nGitHub.com UI uses [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY].

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includeUserRepositories (Boolean)

\n

If true, include user repositories.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

repository (Repository)

Find Repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

Name of Repository to find.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

savedReplies (SavedReplyConnection)

Replies this user has saved.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SavedReplyOrder)

\n

The field to order saved replies by.

\n\n
\n\n
\n\n\n

sponsorshipsAsMaintainer (SponsorshipConnection!)

This object's sponsorships as the maintainer.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includePrivate (Boolean)

\n

Whether or not to include private sponsorships in the result set.

\n

The default value is false.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

sponsorshipsAsSponsor (SponsorshipConnection!)

This object's sponsorships as the sponsor.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

starredRepositories (StarredRepositoryConnection!)

Repositories the user has starred.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n

ownedByViewer (Boolean)

\n

Filters starred repositories to only return repositories owned by the viewer.

\n\n
\n\n
\n\n\n

status (UserStatus)

The user's description of what they're currently doing.

\n\n\n\n\n\n\n\n\n\n\n\n

suspendedAt (DateTime)

Identifies the date and time when the user was suspended.

\n\n\n\n\n\n\n\n\n\n\n\n

topRepositories (RepositoryConnection!)

Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder!)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

since (DateTime)

\n

How far back in time to fetch contributed repositories.

\n\n
\n\n
\n\n\n

twitterUsername (String)

The user's Twitter username.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanChangePinnedItems (Boolean!)

Can the viewer pin repositories and gists to the profile?.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanFollow (Boolean!)

Whether or not the viewer is able to follow the user.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerIsFollowing (Boolean!)

Whether or not this user is followed by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

watching (RepositoryConnection!)

A list of repositories the given user is watching.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Affiliation options for repositories returned from the connection. If none\nspecified, the results will include repositories for which the current\nviewer is an owner or collaborator, or member.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

websiteUrl (URI)

A URL pointing to the user's public website/blog.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserBlockedEvent\n

\n

Represents auser_blockedevent on a given user.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

blockDuration (UserBlockDuration!)

Number of days that the user was blocked for.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (User)

The user who was blocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserContentEdit\n

\n

An edit on user content.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

deletedAt (DateTime)

Identifies the date and time when the object was deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

deletedBy (Actor)

The actor who deleted this content.

\n\n\n\n\n\n\n\n\n\n\n\n

diff (String)

A summary of the changes for this edit.

\n\n\n\n\n\n\n\n\n\n\n\n

editedAt (DateTime!)

When this content was edited.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited this content.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserContentEditConnection\n

\n

A list of edits to content.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserContentEditEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([UserContentEdit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserContentEditEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (UserContentEdit)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserEdge\n

\n

Represents a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserEmailMetadata\n

\n

Email attributes from External Identity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

primary (Boolean)

Boolean to identify primary emails.

\n\n\n\n\n\n\n\n\n\n\n\n

type (String)

Type of email.

\n\n\n\n\n\n\n\n\n\n\n\n

value (String!)

Email id.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserStatus\n

\n

The user's description of what they're currently doing.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

emoji (String)

An emoji summarizing the user's status.

\n\n\n\n\n\n\n\n\n\n\n\n

emojiHTML (HTML)

The status emoji as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

expiresAt (DateTime)

If set, the status will not be shown after this date.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

ID of the object.

\n\n\n\n\n\n\n\n\n\n\n\n

indicatesLimitedAvailability (Boolean!)

Whether this status indicates the user is not fully available on GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

A brief message describing what the user is doing.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The organization whose members can see this status. If null, this status is publicly visible.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who has this status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserStatusConnection\n

\n

The connection type for UserStatus.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserStatusEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([UserStatus])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserStatusEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (UserStatus)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n VerifiableDomain\n

\n

A domain that can be verified for an organization or an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

dnsHostName (URI)

The DNS host name that should be used for verification.

\n\n\n\n\n\n\n\n\n\n\n\n

domain (URI!)

The unicode encoded domain.

\n\n\n\n\n\n\n\n\n\n\n\n

hasFoundHostName (Boolean!)

Whether a TXT record for verification with the expected host name was found.

\n\n\n\n\n\n\n\n\n\n\n\n

hasFoundVerificationToken (Boolean!)

Whether a TXT record for verification with the expected verification token was found.

\n\n\n\n\n\n\n\n\n\n\n\n

isRequiredForPolicyEnforcement (Boolean!)

Whether this domain is required to exist for an organization or enterprise policy to be enforced.

\n\n\n\n\n\n\n\n\n\n\n\n

isVerified (Boolean!)

Whether or not the domain is verified.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (VerifiableDomainOwner!)

The owner of the domain.

\n\n\n\n\n\n\n\n\n\n\n\n

punycodeEncodedDomain (URI!)

The punycode encoded domain.

\n\n\n\n\n\n\n\n\n\n\n\n

tokenExpirationTime (DateTime)

The time that the current verification token will expire.

\n\n\n\n\n\n\n\n\n\n\n\n

verificationToken (String)

The current verification token for the domain.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ViewerHovercardContext\n

\n

A hovercard context with a message describing how the viewer is related.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

viewer (User!)

Identifies the user who is related to this context.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n", + "html": "
\n
\n

\n ActorLocation\n

\n

Location information for an actor.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

city (String)

City.

\n\n\n\n\n\n\n\n\n\n\n\n

country (String)

Country name.

\n\n\n\n\n\n\n\n\n\n\n\n

countryCode (String)

Country code.

\n\n\n\n\n\n\n\n\n\n\n\n

region (String)

Region name.

\n\n\n\n\n\n\n\n\n\n\n\n

regionCode (String)

Region or state code.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AddedToProjectEvent\n

\n

Represents aadded_to_projectevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectCard (ProjectCard)

Project card referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n App\n

\n

A GitHub App.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the app.

\n\n\n\n\n\n\n\n\n\n\n\n

logoBackgroundColor (String!)

The hex color code, without the leading '#', for the logo background.

\n\n\n\n\n\n\n\n\n\n\n\n

logoUrl (URI!)

A URL pointing to the app's logo.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting image.

\n\n
\n\n
\n\n\n

name (String!)

The name of the app.

\n\n\n\n\n\n\n\n\n\n\n\n

slug (String!)

A slug based on the name of the app for use in URLs.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The URL to the app's homepage.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AssignedEvent\n

\n

Represents anassignedevent on any assignable object.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignable (Assignable!)

Identifies the assignable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignee (Assignee)

Identifies the user or mannequin that was assigned.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

Identifies the user who was assigned.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

user is deprecated.

Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoMergeDisabledEvent\n

\n

Represents aauto_merge_disabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

disabler (User)

The user who disabled auto-merge for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (String)

The reason auto-merge was disabled.

\n\n\n\n\n\n\n\n\n\n\n\n

reasonCode (String)

The reason_code relating to why auto-merge was disabled.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoMergeEnabledEvent\n

\n

Represents aauto_merge_enabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enabler (User)

The user who enabled auto-merge for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoMergeRequest\n

\n

Represents an auto-merge request for a pull request.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

authorEmail (String)

The email address of the author of this auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

commitBody (String)

The commit message of the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

commitHeadline (String)

The commit title of the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

enabledAt (DateTime)

When was this auto-merge request was enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

enabledBy (Actor)

The actor who created the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeMethod (PullRequestMergeMethod!)

The merge method of the auto-merge request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request that this auto-merge request is set against.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoRebaseEnabledEvent\n

\n

Represents aauto_rebase_enabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enabler (User)

The user who enabled auto-merge (rebase) for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutoSquashEnabledEvent\n

\n

Represents aauto_squash_enabledevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enabler (User)

The user who enabled auto-merge (squash) for this Pull Request.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutomaticBaseChangeFailedEvent\n

\n

Represents aautomatic_base_change_failedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

newBase (String!)

The new base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

oldBase (String!)

The old base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n AutomaticBaseChangeSucceededEvent\n

\n

Represents aautomatic_base_change_succeededevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

newBase (String!)

The new base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

oldBase (String!)

The old base for this PR.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BaseRefChangedEvent\n

\n

Represents abase_ref_changedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

currentRefName (String!)

Identifies the name of the base ref for the pull request after it was changed.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

previousRefName (String!)

Identifies the name of the base ref for the pull request before it was changed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BaseRefDeletedEvent\n

\n

Represents abase_ref_deletedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String)

Identifies the name of the Ref associated with the base_ref_deleted event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BaseRefForcePushedEvent\n

\n

Represents abase_ref_force_pushedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

afterCommit (Commit)

Identifies the after commit SHA for thebase_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeCommit (Commit)

Identifies the before commit SHA for thebase_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the fully qualified ref name for thebase_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Blame\n

\n

Represents a Git blame.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

ranges ([BlameRange!]!)

The list of ranges from a Git blame.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BlameRange\n

\n

Represents a range of information from a Git blame.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

age (Int!)

Identifies the recency of the change, from 1 (new) to 10 (old). This is\ncalculated as a 2-quantile and determines the length of distance between the\nmedian age of all the changes in the file and the recency of the current\nrange's change.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit!)

Identifies the line author.

\n\n\n\n\n\n\n\n\n\n\n\n

endingLine (Int!)

The ending line for the range.

\n\n\n\n\n\n\n\n\n\n\n\n

startingLine (Int!)

The starting line for the range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Blob\n

\n

Represents a Git blob.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

byteSize (Int!)

Byte size of Blob object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

isBinary (Boolean)

Indicates whether the Blob is binary or text. Returns null if unable to determine the encoding.

\n\n\n\n\n\n\n\n\n\n\n\n

isTruncated (Boolean!)

Indicates whether the contents is truncated.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the Git object belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

UTF8 text data or null if the Blob is binary.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Bot\n

\n

A special type of user which takes actions on behalf of GitHub Apps.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the GitHub App's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The username of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this bot.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this bot.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRule\n

\n

A branch protection rule.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean!)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean!)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRuleConflicts (BranchProtectionRuleConflictConnection!)

A list of conflicts matching branches protection rule and other branch protection rules.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

creator (Actor)

The actor who created this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissesStaleReviews (Boolean!)

Will new commits pushed to matching branches dismiss pull request review approvals.

\n\n\n\n\n\n\n\n\n\n\n\n

isAdminEnforced (Boolean!)

Can admins overwrite branch protection.

\n\n\n\n\n\n\n\n\n\n\n\n

matchingRefs (RefConnection!)

Repository refs that are protected by this rule.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters refs with query on name.

\n\n
\n\n
\n\n\n

pattern (String!)

Identifies the protection rule pattern.

\n\n\n\n\n\n\n\n\n\n\n\n

pushAllowances (PushAllowanceConnection!)

A list push allowances for this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

repository (Repository)

The repository associated with this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresApprovingReviews (Boolean!)

Are approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCodeOwnerReviews (Boolean!)

Are reviews from code owners required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresCommitSignatures (Boolean!)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean!)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStatusChecks (Boolean!)

Are status checks required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresStrictStatusChecks (Boolean!)

Are branches required to be up to date before merging.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsPushes (Boolean!)

Is pushing to matching branches restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

restrictsReviewDismissals (Boolean!)

Is dismissal of pull request reviews restricted.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDismissalAllowances (ReviewDismissalAllowanceConnection!)

A list review dismissal allowances for this branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConflict\n

\n

A conflict between two branch protection rules.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

conflictingBranchProtectionRule (BranchProtectionRule)

Identifies the conflicting branch protection rule.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the branch ref that has conflicting rules.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConflictConnection\n

\n

The connection type for BranchProtectionRuleConflict.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([BranchProtectionRuleConflictEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([BranchProtectionRuleConflict])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConflictEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (BranchProtectionRuleConflict)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleConnection\n

\n

The connection type for BranchProtectionRule.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([BranchProtectionRuleEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([BranchProtectionRule])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n BranchProtectionRuleEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (BranchProtectionRule)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CVSS\n

\n

The Common Vulnerability Scoring System.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

score (Float!)

The CVSS score associated with this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

vectorString (String)

The CVSS vector string associated with this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CWE\n

\n

A common weakness enumeration.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cweId (String!)

The id of the CWE.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String!)

A detailed description of this CWE.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

ID of the object.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of this CWE.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CWEConnection\n

\n

The connection type for CWE.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CWEEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CWE])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CWEEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CWE)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotation\n

\n

A single check annotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotationLevel (CheckAnnotationLevel)

The annotation's severity level.

\n\n\n\n\n\n\n\n\n\n\n\n

blobUrl (URI!)

The path to the file that this annotation was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

location (CheckAnnotationSpan!)

The position of this annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String!)

The annotation's message.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path that this annotation was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

rawDetails (String)

Additional information about the annotation.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The annotation's title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationConnection\n

\n

The connection type for CheckAnnotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CheckAnnotationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CheckAnnotation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CheckAnnotation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationPosition\n

\n

A character position in a check annotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

column (Int)

Column number (1 indexed).

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int!)

Line number (1 indexed).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckAnnotationSpan\n

\n

An inclusive pair of positions for a check annotation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

end (CheckAnnotationPosition!)

End position (inclusive).

\n\n\n\n\n\n\n\n\n\n\n\n

start (CheckAnnotationPosition!)

Start position (inclusive).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckRun\n

\n

A check run.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

annotations (CheckAnnotationConnection)

The check run's annotations.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

checkSuite (CheckSuite!)

The check suite that this run is a part of.

\n\n\n\n\n\n\n\n\n\n\n\n

completedAt (DateTime)

Identifies the date and time when the check run was completed.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The conclusion of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

detailsUrl (URI)

The URL from which to find full details of the check run on the integrator's site.

\n\n\n\n\n\n\n\n\n\n\n\n

externalId (String)

A reference for the check run on the integrator's system.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the check for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI!)

The permalink to the check run summary.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this check run.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime)

Identifies the date and time when the check run was started.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState!)

The current status of the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String)

A string representing the check run's summary.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

A string representing the check run's text.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

A string representing the check run.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this check run.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckRunConnection\n

\n

The connection type for CheckRun.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CheckRunEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CheckRun])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckRunEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CheckRun)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckSuite\n

\n

A check suite.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

app (App)

The GitHub App which created this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

branch (Ref)

The name of the branch for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

checkRuns (CheckRunConnection)

The check runs associated with a check suite.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (CheckRunFilter)

\n

Filters the check runs by this type.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit!)

The commit for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

conclusion (CheckConclusionState)

The conclusion of this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

matchingPullRequests (PullRequestConnection)

A list of open pull requests matching the check suite.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

push (Push)

The push that triggered this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

status (CheckStatusState!)

The status of this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this check suite.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckSuiteConnection\n

\n

The connection type for CheckSuite.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CheckSuiteEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CheckSuite])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CheckSuiteEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CheckSuite)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ClosedEvent\n

\n

Represents aclosedevent on any Closable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

closable (Closable!)

Object that was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

closer (Closer)

Object which triggered the creation of this event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this closed event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this closed event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CodeOfConduct\n

\n

The Code of Conduct for a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The body of the Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The key for the Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The formal name of the Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI)

The HTTP path for this Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI)

The HTTP URL for this Code of Conduct.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommentDeletedEvent\n

\n

Represents acomment_deletedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deletedCommentAuthor (Actor)

The user who authored the deleted comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Commit\n

\n

Represents a Git commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

additions (Int!)

The number of additions in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

associatedPullRequests (PullRequestConnection)

The pull requests associated with a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (PullRequestOrder)

\n

Ordering options for pull requests.

\n\n
\n\n
\n\n\n

author (GitActor)

Authorship details of the commit.

\n\n\n\n\n\n\n\n\n\n\n\n

authoredByCommitter (Boolean!)

Check if the committer and the author match.

\n\n\n\n\n\n\n\n\n\n\n\n

authoredDate (DateTime!)

The datetime when this commit was authored.

\n\n\n\n\n\n\n\n\n\n\n\n

authors (GitActorConnection!)

The list of authors for this commit based on the git author and the Co-authored-by\nmessage trailer. The git author will always be first.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

blame (Blame!)

Fetches git blame information.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

path (String!)

\n

The file whose Git blame information you want.

\n\n
\n\n
\n\n\n

changedFiles (Int!)

The number of changed files in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

checkSuites (CheckSuiteConnection)

The check suites associated with a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (CheckSuiteFilter)

\n

Filters the check suites by this type.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

comments (CommitCommentConnection!)

Comments made on the commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

committedDate (DateTime!)

The datetime when this commit was committed.

\n\n\n\n\n\n\n\n\n\n\n\n

committedViaWeb (Boolean!)

Check if committed via GitHub web UI.

\n\n\n\n\n\n\n\n\n\n\n\n

committer (GitActor)

Committer details of the commit.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions (Int!)

The number of deletions in this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

deployments (DeploymentConnection)

The deployments associated with a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

environments ([String!])

\n

Environments to list deployments for.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (DeploymentOrder)

\n

Ordering options for deployments returned from the connection.

\n\n
\n\n
\n\n\n

file (TreeEntry)

The tree entry representing the file located at the given path.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

path (String!)

\n

The path for the file.

\n\n
\n\n
\n\n\n

history (CommitHistoryConnection!)

The linear commit history starting from (and including) this commit, in the same order as git log.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

author (CommitAuthor)

\n

If non-null, filters history to only show commits with matching authorship.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

path (String)

\n

If non-null, filters history to only show commits touching files under this path.

\n\n
\n\n
\n

since (GitTimestamp)

\n

Allows specifying a beginning time or date for fetching commits.

\n\n
\n\n
\n

until (GitTimestamp)

\n

Allows specifying an ending time or date for fetching commits.

\n\n
\n\n
\n\n\n

message (String!)

The Git commit message.

\n\n\n\n\n\n\n\n\n\n\n\n

messageBody (String!)

The Git commit message body.

\n\n\n\n\n\n\n\n\n\n\n\n

messageBodyHTML (HTML!)

The commit message body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

messageHeadline (String!)

The Git commit message headline.

\n\n\n\n\n\n\n\n\n\n\n\n

messageHeadlineHTML (HTML!)

The commit message headline rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

onBehalfOf (Organization)

The organization this commit was made on behalf of.

\n\n\n\n\n\n\n\n\n\n\n\n

parents (CommitConnection!)

The parents of a commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pushedDate (DateTime)

The datetime when this commit was pushed.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository this commit belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (GitSignature)

Commit signing information, if present.

\n\n\n\n\n\n\n\n\n\n\n\n

status (Status)

Status information for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

statusCheckRollup (StatusCheckRollup)

Check and Status rollup information for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

submodules (SubmoduleConnection!)

Returns a list of all submodules in this repository as of this Commit parsed from the .gitmodules file.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

tarballUrl (URI!)

Returns a URL to download a tarball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

\n\n\n\n\n\n\n\n\n\n\n\n

tree (Tree!)

Commit's root Tree.

\n\n\n\n\n\n\n\n\n\n\n\n

treeResourcePath (URI!)

The HTTP path for the tree of this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

treeUrl (URI!)

The HTTP URL for the tree of this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n

zipballUrl (URI!)

Returns a URL to download a zipball archive for a repository.\nNote: For private repositories, these links are temporary and expire after five minutes.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitComment\n

\n

Represents a comment on a given Commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with the comment, if the commit exists.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

Identifies the file path associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

Identifies the line position associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path permalink for this commit comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL permalink for this commit comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitCommentConnection\n

\n

The connection type for CommitComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CommitCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CommitComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CommitComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitCommentThread\n

\n

A thread of comments on a commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (CommitCommentConnection!)

The comments that exist in this thread.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit)

The commit the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The file the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The position in the diff for the commit that the comment was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitConnection\n

\n

The connection type for Commit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CommitEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Commit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitContributionsByRepository\n

\n

This aggregates commits made by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedCommitContributionConnection!)

The commit contributions, each representing a day.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (CommitContributionOrder)

\n

Ordering options for commit contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the commits were made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for the user's commits to the repository in this time range.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for the user's commits to the repository in this time range.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Commit)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CommitHistoryConnection\n

\n

The connection type for Commit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CommitEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Commit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ConnectedEvent\n

\n

Represents aconnectedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

source (ReferencedSubject!)

Issue or pull request that made the reference.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (ReferencedSubject!)

Issue or pull request which was connected.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContentAttachment\n

\n

A content attachment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body text of the content attachment. This parameter supports markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

contentReference (ContentReference!)

The content reference that the content attachment is attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int!)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the content attachment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContentReference\n

\n

A content reference.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

databaseId (Int!)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

reference (String!)

The reference of the content reference.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendar\n

\n

A calendar of contributions made on GitHub by a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

colors ([String!]!)

A list of hex color codes used in this calendar. The darker the color, the more contributions it represents.

\n\n\n\n\n\n\n\n\n\n\n\n

isHalloween (Boolean!)

Determine if the color set was chosen because it's currently Halloween.

\n\n\n\n\n\n\n\n\n\n\n\n

months ([ContributionCalendarMonth!]!)

A list of the months of contributions in this calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

totalContributions (Int!)

The count of total contributions in the calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

weeks ([ContributionCalendarWeek!]!)

A list of the weeks of contributions in this calendar.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendarDay\n

\n

Represents a single day of contributions on GitHub by a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

color (String!)

The hex color code that represents how many contributions were made on this day compared to others in the calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionCount (Int!)

How many contributions were made by the user on this day.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionLevel (ContributionLevel!)

Indication of contributions, relative to other days. Can be used to indicate\nwhich color to represent this day on a calendar.

\n\n\n\n\n\n\n\n\n\n\n\n

date (Date!)

The day this square represents.

\n\n\n\n\n\n\n\n\n\n\n\n

weekday (Int!)

A number representing which day of the week this square represents, e.g., 1 is Monday.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendarMonth\n

\n

A month of contributions in a user's contribution graph.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

firstDay (Date!)

The date of the first day of this month.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the month.

\n\n\n\n\n\n\n\n\n\n\n\n

totalWeeks (Int!)

How many weeks started in this month.

\n\n\n\n\n\n\n\n\n\n\n\n

year (Int!)

The year the month occurred in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionCalendarWeek\n

\n

A week of contributions in a user's contribution graph.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributionDays ([ContributionCalendarDay!]!)

The days of contributions in this week.

\n\n\n\n\n\n\n\n\n\n\n\n

firstDay (Date!)

The date of the earliest square in this week.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ContributionsCollection\n

\n

A contributions collection aggregates contributions such as opened issues and commits created by a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commitContributionsByRepository ([CommitContributionsByRepository!]!)

Commit contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

contributionCalendar (ContributionCalendar!)

A calendar of this user's contributions on GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionYears ([Int!]!)

The years the user has been making contributions with the most recent year first.

\n\n\n\n\n\n\n\n\n\n\n\n

doesEndInCurrentMonth (Boolean!)

Determine if this collection's time span ends in the current month.

\n\n\n\n\n\n\n\n\n\n\n\n

earliestRestrictedContributionDate (Date)

The date of the first restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

endedAt (DateTime!)

The ending date and time of this collection.

\n\n\n\n\n\n\n\n\n\n\n\n

firstIssueContribution (CreatedIssueOrRestrictedContribution)

The first issue the user opened on GitHub. This will be null if that issue was\nopened outside the collection's time range and ignoreTimeRange is false. If\nthe issue is not visible but the user has opted to show private contributions,\na RestrictedContribution will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

firstPullRequestContribution (CreatedPullRequestOrRestrictedContribution)

The first pull request the user opened on GitHub. This will be null if that\npull request was opened outside the collection's time range and\nignoreTimeRange is not true. If the pull request is not visible but the user\nhas opted to show private contributions, a RestrictedContribution will be returned.

\n\n\n\n\n\n\n\n\n\n\n\n

firstRepositoryContribution (CreatedRepositoryOrRestrictedContribution)

The first repository the user created on GitHub. This will be null if that\nfirst repository was created outside the collection's time range and\nignoreTimeRange is false. If the repository is not visible, then a\nRestrictedContribution is returned.

\n\n\n\n\n\n\n\n\n\n\n\n

hasActivityInThePast (Boolean!)

Does the user have any more activity in the timeline that occurred prior to the collection's time range?.

\n\n\n\n\n\n\n\n\n\n\n\n

hasAnyContributions (Boolean!)

Determine if there are any contributions in this collection.

\n\n\n\n\n\n\n\n\n\n\n\n

hasAnyRestrictedContributions (Boolean!)

Determine if the user made any contributions in this time frame whose details\nare not visible because they were made in a private repository. Can only be\ntrue if the user enabled private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

isSingleDay (Boolean!)

Whether or not the collector's time span is all within the same day.

\n\n\n\n\n\n\n\n\n\n\n\n

issueContributions (CreatedIssueContributionConnection!)

A list of issues the user opened.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

issueContributionsByRepository ([IssueContributionsByRepository!]!)

Issue contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

joinedGitHubContribution (JoinedGitHubContribution)

When the user signed up for GitHub. This will be null if that sign up date\nfalls outside the collection's time range and ignoreTimeRange is false.

\n\n\n\n\n\n\n\n\n\n\n\n

latestRestrictedContributionDate (Date)

The date of the most recent restricted contribution the user made in this time\nperiod. Can only be non-null when the user has enabled private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

mostRecentCollectionWithActivity (ContributionsCollection)

When this collection's time range does not include any activity from the user, use this\nto get a different collection from an earlier time range that does have activity.

\n\n\n\n\n\n\n\n\n\n\n\n

mostRecentCollectionWithoutActivity (ContributionsCollection)

Returns a different contributions collection from an earlier time range than this one\nthat does not have any contributions.

\n\n\n\n\n\n\n\n\n\n\n\n

popularIssueContribution (CreatedIssueContribution)

The issue the user opened on GitHub that received the most comments in the specified\ntime frame.

\n\n\n\n\n\n\n\n\n\n\n\n

popularPullRequestContribution (CreatedPullRequestContribution)

The pull request the user opened on GitHub that received the most comments in the\nspecified time frame.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestContributions (CreatedPullRequestContributionConnection!)

Pull request contributions made by the user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

pullRequestContributionsByRepository ([PullRequestContributionsByRepository!]!)

Pull request contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

pullRequestReviewContributions (CreatedPullRequestReviewContributionConnection!)

Pull request review contributions made by the user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

pullRequestReviewContributionsByRepository ([PullRequestReviewContributionsByRepository!]!)

Pull request review contributions made by the user, grouped by repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

maxRepositories (Int)

\n

How many repositories should be included.

\n

The default value is 25.

\n
\n\n
\n\n\n

repositoryContributions (CreatedRepositoryContributionConnection!)

A list of repositories owned by the user that the user created in this time range.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first repository ever be excluded from the result.

\n

The default value is false.

\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

restrictedContributionsCount (Int!)

A count of contributions made by the user that the viewer cannot access. Only\nnon-zero when the user has chosen to share their private contribution counts.

\n\n\n\n\n\n\n\n\n\n\n\n

startedAt (DateTime!)

The beginning date and time of this collection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCommitContributions (Int!)

How many commits were made by the user in this time span.

\n\n\n\n\n\n\n\n\n\n\n\n

totalIssueContributions (Int!)

How many issues the user opened.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalPullRequestContributions (Int!)

How many pull requests the user opened.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalPullRequestReviewContributions (Int!)

How many pull request reviews the user left.

\n\n\n\n\n\n\n\n\n\n\n\n

totalRepositoriesWithContributedCommits (Int!)

How many different repositories the user committed to.

\n\n\n\n\n\n\n\n\n\n\n\n

totalRepositoriesWithContributedIssues (Int!)

How many different repositories the user opened issues in.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first issue ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented issue be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalRepositoriesWithContributedPullRequestReviews (Int!)

How many different repositories the user left pull request reviews in.

\n\n\n\n\n\n\n\n\n\n\n\n

totalRepositoriesWithContributedPullRequests (Int!)

How many different repositories the user opened pull requests in.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first pull request ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n

excludePopular (Boolean)

\n

Should the user's most commented pull request be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

totalRepositoryContributions (Int!)

How many repositories the user created.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

excludeFirst (Boolean)

\n

Should the user's first repository ever be excluded from this count.

\n

The default value is false.

\n
\n\n
\n\n\n

user (User!)

The user who made the contributions in this collection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ConvertToDraftEvent\n

\n

Represents aconvert_to_draftevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this convert to draft event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this convert to draft event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ConvertedNoteToIssueEvent\n

\n

Represents aconverted_note_to_issueevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectCard (ProjectCard)

Project card referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedCommitContribution\n

\n

Represents the contribution a user made by committing to a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commitCount (Int!)

How many commits were made on this day to this repository by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository the user made a commit in.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedCommitContributionConnection\n

\n

The connection type for CreatedCommitContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedCommitContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedCommitContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of commits across days and repositories in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedCommitContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedCommitContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedIssueContribution\n

\n

Represents the contribution a user made on GitHub by opening an issue.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

The issue that was opened.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedIssueContributionConnection\n

\n

The connection type for CreatedIssueContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedIssueContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedIssueContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedIssueContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedIssueContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestContribution\n

\n

Represents the contribution a user made on GitHub by opening a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request that was opened.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestContributionConnection\n

\n

The connection type for CreatedPullRequestContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedPullRequestContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedPullRequestContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedPullRequestContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestReviewContribution\n

\n

Represents the contribution a user made by leaving a review on a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request the user reviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReview (PullRequestReview!)

The review the user left on the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository containing the pull request that the user reviewed.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestReviewContributionConnection\n

\n

The connection type for CreatedPullRequestReviewContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedPullRequestReviewContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedPullRequestReviewContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedPullRequestReviewContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedPullRequestReviewContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedRepositoryContribution\n

\n

Represents the contribution a user made on GitHub by creating a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository that was created.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedRepositoryContributionConnection\n

\n

The connection type for CreatedRepositoryContribution.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([CreatedRepositoryContributionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([CreatedRepositoryContribution])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CreatedRepositoryContributionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (CreatedRepositoryContribution)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n CrossReferencedEvent\n

\n

Represents a mention made by one issue or pull request to another.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

referencedAt (DateTime!)

Identifies when the reference was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

source (ReferencedSubject!)

Issue or pull request that made the reference.

\n\n\n\n\n\n\n\n\n\n\n\n

target (ReferencedSubject!)

Issue or pull request to which the reference was made.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

willCloseTarget (Boolean!)

Checks if the target will be closed when the source is merged.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DemilestonedEvent\n

\n

Represents ademilestonedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneTitle (String!)

Identifies the milestone title associated with thedemilestonedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (MilestoneItem!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployKey\n

\n

A repository deploy key.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The deploy key.

\n\n\n\n\n\n\n\n\n\n\n\n

readOnly (Boolean!)

Whether or not the deploy key is read only.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The deploy key title.

\n\n\n\n\n\n\n\n\n\n\n\n

verified (Boolean!)

Whether or not the deploy key has been verified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployKeyConnection\n

\n

The connection type for DeployKey.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeployKeyEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([DeployKey])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployKeyEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (DeployKey)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeployedEvent\n

\n

Represents adeployedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deployment (Deployment!)

The deployment associated with thedeployedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

The ref associated with thedeployedevent.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Deployment\n

\n

Represents triggered deployment instance.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commit (Commit)

Identifies the commit sha of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

commitOid (String!)

Identifies the oid of the deployment commit, even if the commit has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor!)

Identifies the actor who triggered the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The deployment description.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

The latest environment to which this deployment was made.

\n\n\n\n\n\n\n\n\n\n\n\n

latestEnvironment (String)

The latest environment to which this deployment was made.

\n\n\n\n\n\n\n\n\n\n\n\n

latestStatus (DeploymentStatus)

The latest status of this deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

originalEnvironment (String)

The original environment to which this deployment was made.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String)

Extra information that a deployment system might need.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the Ref of the deployment, if the deployment was created by ref.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

Identifies the repository associated with the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentState)

The current state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

statuses (DeploymentStatusConnection)

A list of statuses associated with the deployment.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

task (String)

The deployment task.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentConnection\n

\n

The connection type for Deployment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeploymentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Deployment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Deployment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentEnvironmentChangedEvent\n

\n

Represents adeployment_environment_changedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

deploymentStatus (DeploymentStatus!)

The deployment status that updated the deployment environment.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentStatus\n

\n

Describes the status of a given deployment attempt.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor!)

Identifies the actor who triggered the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

deployment (Deployment!)

Identifies the deployment associated with status.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Identifies the description of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

environment (String)

Identifies the environment of the deployment at the time of this deployment status.

\n\n\n\n\n
\n

Preview notice

\n

environment is available under the Deployments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

environmentUrl (URI)

Identifies the environment URL of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

logUrl (URI)

Identifies the log URL of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (DeploymentStatusState!)

Identifies the current state of the deployment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentStatusConnection\n

\n

The connection type for DeploymentStatus.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([DeploymentStatusEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([DeploymentStatus])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DeploymentStatusEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (DeploymentStatus)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n DisconnectedEvent\n

\n

Represents adisconnectedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

source (ReferencedSubject!)

Issue or pull request from which the issue was disconnected.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (ReferencedSubject!)

Issue or pull request which was disconnected.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Enterprise\n

\n

An account to manage multiple organizations with consolidated policy and billing.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the enterprise's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

billingInfo (EnterpriseBillingInfo)

Enterprise billing information visible to enterprise billing managers.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML!)

The description of the enterprise as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The location of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

members (EnterpriseMemberConnection!)

A list of users who are members of this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

deployment (EnterpriseUserDeployment)

\n

Only return members within the selected GitHub Enterprise deployment.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for members returned from the connection.

\n\n
\n\n
\n

organizationLogins ([String!])

\n

Only return members within the organizations with these logins.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseUserAccountMembershipRole)

\n

The role of the user in the enterprise organization or server.

\n\n
\n\n
\n\n\n

name (String!)

The name of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

organizations (OrganizationConnection!)

A list of organizations that belong to this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

ownerInfo (EnterpriseOwnerInfo)

Enterprise information only visible to enterprise owners.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

slug (String!)

The URL-friendly identifier for the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

userAccounts (EnterpriseUserAccountConnection!)

A list of user accounts on this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerIsAdmin (Boolean!)

Is the current viewer an admin of this enterprise?.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (URI)

The URL of the enterprise website.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseAdministratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorEdge\n

\n

A User who is an administrator of an enterprise.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole!)

The role of the administrator.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitation\n

\n

An invitation for a user to become an owner or billing manager of an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email of the person who was invited to the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise!)

The enterprise the invitation is for.

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (User)

The user who was invited to the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

inviter (User)

The user who created the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseAdministratorRole!)

The invitee's pending role in the enterprise (owner or billing_manager).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationConnection\n

\n

The connection type for EnterpriseAdministratorInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseAdministratorInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseAdministratorInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseAdministratorInvitationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseAdministratorInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseBillingInfo\n

\n

Enterprise billing information visible to enterprise billing managers and owners.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allLicensableUsersCount (Int!)

The number of licenseable users/emails across the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

assetPacks (Int!)

The number of data packs used by all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

availableSeats (Int!)

The number of available seats across all owned organizations based on the unique number of billable users.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

availableSeats is deprecated.

availableSeats will be replaced with totalAvailableLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalAvailableLicenses instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n

bandwidthQuota (Float!)

The bandwidth quota in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

bandwidthUsage (Float!)

The bandwidth usage in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

bandwidthUsagePercentage (Int!)

The bandwidth usage as a percentage of the bandwidth quota.

\n\n\n\n\n\n\n\n\n\n\n\n

seats (Int!)

The total seats across all organizations owned by the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

seats is deprecated.

seats will be replaced with totalLicenses to provide more clarity on the value being returned Use EnterpriseBillingInfo.totalLicenses instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n

storageQuota (Float!)

The storage quota in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

storageUsage (Float!)

The storage usage in GB for all organizations owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

storageUsagePercentage (Int!)

The storage usage as a percentage of the storage quota.

\n\n\n\n\n\n\n\n\n\n\n\n

totalAvailableLicenses (Int!)

The number of available licenses across all owned organizations based on the unique number of billable users.

\n\n\n\n\n\n\n\n\n\n\n\n

totalLicenses (Int!)

The total number of licenses allocated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseIdentityProvider\n

\n

An identity provider configured to provision identities for an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

digestMethod (SamlDigestAlgorithm)

The digest algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise)

The enterprise this identity provider belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

externalIdentities (ExternalIdentityConnection!)

ExternalIdentities provisioned by this identity provider.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

idpCertificate (X509Certificate)

The x509 certificate used by the identity provider to sign assertions and responses.

\n\n\n\n\n\n\n\n\n\n\n\n

issuer (String)

The Issuer Entity ID for the SAML identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

recoveryCodes ([String!])

Recovery codes that can be used by admins to access the enterprise if the identity provider is unavailable.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethod (SamlSignatureAlgorithm)

The signature algorithm used to sign SAML requests for the identity provider.

\n\n\n\n\n\n\n\n\n\n\n\n

ssoUrl (URI)

The URL endpoint for the identity provider's SAML SSO.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberConnection\n

\n

The connection type for EnterpriseMember.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseMemberEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseMember])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseMemberEdge\n

\n

A User who is a member of an enterprise through one or more organizations.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the user does not have a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All members consume a license Removal on 2021-01-01 UTC.

\n
\n\n\n\n\n\n\n

node (EnterpriseMember)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOrganizationMembershipConnection\n

\n

The connection type for Organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseOrganizationMembershipEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Organization])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOrganizationMembershipEdge\n

\n

An enterprise organization that a user is a member of.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Organization)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

role (EnterpriseUserAccountMembershipRole!)

The role of the user in the enterprise membership.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOutsideCollaboratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseOutsideCollaboratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOutsideCollaboratorEdge\n

\n

A User who is an outside collaborator of an enterprise through one or more organizations.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the outside collaborator does not have a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All outside collaborators consume a license Removal on 2021-01-01 UTC.

\n
\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (EnterpriseRepositoryInfoConnection!)

The enterprise organization repositories this user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseOwnerInfo\n

\n

Enterprise information only visible to enterprise owners.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

admins (EnterpriseAdministratorConnection!)

A list of all of the administrators for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for administrators returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseAdministratorRole)

\n

The role to filter by.

\n\n
\n\n
\n\n\n

affiliatedUsersWithTwoFactorDisabled (UserConnection!)

A list of users in the enterprise who currently have two-factor authentication disabled.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

affiliatedUsersWithTwoFactorDisabledExist (Boolean!)

Whether or not affiliated users with two-factor authentication disabled exist in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

allowPrivateRepositoryForkingSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether private repository forking is enabled for repositories in organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

allowPrivateRepositoryForkingSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided private repository forking setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

defaultRepositoryPermissionSetting (EnterpriseDefaultRepositoryPermissionSettingValue!)

The setting value for base repository permissions for organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

defaultRepositoryPermissionSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided default repository permission.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (DefaultRepositoryPermissionField!)

\n

The permission to find organizations for.

\n\n
\n\n
\n\n\n

ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

The setting value for whether the enterprise has an IP allow list enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntries (IpAllowListEntryConnection!)

The IP addresses that are allowed to access resources owned by the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IpAllowListEntryOrder)

\n

Ordering options for IP allow list entries returned.

\n\n
\n\n
\n\n\n

isUpdatingDefaultRepositoryPermission (Boolean!)

Whether or not the default repository permission is currently being updated.

\n\n\n\n\n\n\n\n\n\n\n\n

isUpdatingTwoFactorRequirement (Boolean!)

Whether the two-factor authentication requirement is currently being enforced.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanChangeRepositoryVisibilitySetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether organization members with admin permissions on a\nrepository can change repository visibility.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanChangeRepositoryVisibilitySettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided can change repository visibility setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanCreateInternalRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create internal repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePrivateRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create private repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreatePublicRepositoriesSetting (Boolean)

The setting value for whether members of organizations in the enterprise can create public repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesSetting (EnterpriseMembersCanCreateRepositoriesSettingValue)

The setting value for whether members of organizations in the enterprise can create repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanCreateRepositoriesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided repository creation setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (OrganizationMembersCanCreateRepositoriesSettingValue!)

\n

The setting to find organizations for.

\n\n
\n\n
\n\n\n

membersCanDeleteIssuesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can delete issues.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanDeleteIssuesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can delete issues setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanDeleteRepositoriesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can delete or transfer repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanDeleteRepositoriesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can delete repositories setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanInviteCollaboratorsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members of organizations in the enterprise can invite outside collaborators.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanInviteCollaboratorsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can invite collaborators setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanMakePurchasesSetting (EnterpriseMembersCanMakePurchasesSettingValue!)

Indicates whether members of this enterprise's organizations can purchase additional services for those organizations.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanUpdateProtectedBranchesSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members with admin permissions for repositories can update protected branches.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanUpdateProtectedBranchesSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can update protected branches setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

membersCanViewDependencyInsightsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether members can view dependency insights.

\n\n\n\n\n\n\n\n\n\n\n\n

membersCanViewDependencyInsightsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided members can view dependency insights setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

organizationProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether organization projects are enabled for organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationProjectsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided organization projects setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

outsideCollaborators (EnterpriseOutsideCollaboratorConnection!)

A list of outside collaborators across the repositories in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

login (String)

\n

The login of one specific outside collaborator.

\n\n
\n\n
\n

orderBy (EnterpriseMemberOrder)

\n

Ordering options for outside collaborators returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

visibility (RepositoryVisibility)

\n

Only return outside collaborators on repositories with this visibility.

\n\n
\n\n
\n\n\n

pendingAdminInvitations (EnterpriseAdministratorInvitationConnection!)

A list of pending administrator invitations for the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseAdministratorInvitationOrder)

\n

Ordering options for pending enterprise administrator invitations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseAdministratorRole)

\n

The role to filter by.

\n\n
\n\n
\n\n\n

pendingCollaboratorInvitations (RepositoryInvitationConnection!)

A list of pending collaborator invitations across the repositories in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryInvitationOrder)

\n

Ordering options for pending repository collaborator invitations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

pendingCollaborators (EnterprisePendingCollaboratorConnection!)

A list of pending collaborators across the repositories in the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

pendingCollaborators is deprecated.

Repository invitations can now be associated with an email, not only an invitee. Use the pendingCollaboratorInvitations field instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryInvitationOrder)

\n

Ordering options for pending repository collaborator invitations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

pendingMemberInvitations (EnterprisePendingMemberInvitationConnection!)

A list of pending member invitations for organizations in the enterprise.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

repositoryProjectsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether repository projects are enabled in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryProjectsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided repository projects setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

samlIdentityProvider (EnterpriseIdentityProvider)

The SAML Identity Provider for the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

samlIdentityProviderSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the SAML single sign-on setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (IdentityProviderConfigurationState!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

teamDiscussionsSetting (EnterpriseEnabledDisabledSettingValue!)

The setting value for whether team discussions are enabled for organizations in this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

teamDiscussionsSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the provided team discussions setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n

twoFactorRequiredSetting (EnterpriseEnabledSettingValue!)

The setting value for whether the enterprise requires two-factor authentication for its organizations and users.

\n\n\n\n\n\n\n\n\n\n\n\n

twoFactorRequiredSettingOrganizations (OrganizationConnection!)

A list of enterprise organizations configured with the two-factor authentication setting value.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations with this setting.

\n\n
\n\n
\n

value (Boolean!)

\n

The setting value to find organizations for.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingCollaboratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterprisePendingCollaboratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingCollaboratorEdge\n

\n

A user with an invitation to be a collaborator on a repository owned by an organization in an enterprise.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the invited collaborator does not have a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All pending collaborators consume a license Removal on 2021-01-01 UTC.

\n
\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (EnterpriseRepositoryInfoConnection!)

The enterprise organization repositories this user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingMemberInvitationConnection\n

\n

The connection type for OrganizationInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterprisePendingMemberInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([OrganizationInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalUniqueUserCount (Int!)

Identifies the total count of unique users in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterprisePendingMemberInvitationEdge\n

\n

An invitation to be a member in an enterprise organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

isUnlicensed (Boolean!)

Whether the invitation has a license for the enterprise.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

isUnlicensed is deprecated.

All pending members consume a license Removal on 2020-07-01 UTC.

\n
\n\n\n\n\n\n\n

node (OrganizationInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseRepositoryInfo\n

\n

A subset of repository information queryable from an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isPrivate (Boolean!)

Identifies if the repository is private.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The repository's name.

\n\n\n\n\n\n\n\n\n\n\n\n

nameWithOwner (String!)

The repository's name with owner.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseRepositoryInfoConnection\n

\n

The connection type for EnterpriseRepositoryInfo.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseRepositoryInfoEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseRepositoryInfo])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseRepositoryInfoEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseRepositoryInfo)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerInstallation\n

\n

An Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

customerName (String!)

The customer name to which the Enterprise Server installation belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

hostName (String!)

The host name of the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

isConnected (Boolean!)

Whether or not the installation is connected to an Enterprise Server installation via GitHub Connect.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

userAccounts (EnterpriseServerUserAccountConnection!)

User accounts on this Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerUserAccountOrder)

\n

Ordering options for Enterprise Server user accounts returned from the connection.

\n\n
\n\n
\n\n\n

userAccountsUploads (EnterpriseServerUserAccountsUploadConnection!)

User accounts uploads for the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerUserAccountsUploadOrder)

\n

Ordering options for Enterprise Server user accounts uploads returned from the connection.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccount\n

\n

A user account on an Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

emails (EnterpriseServerUserAccountEmailConnection!)

User emails belonging to this user account.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (EnterpriseServerUserAccountEmailOrder)

\n

Ordering options for Enterprise Server user account emails returned from the connection.

\n\n
\n\n
\n\n\n

enterpriseServerInstallation (EnterpriseServerInstallation!)

The Enterprise Server installation on which this user account exists.

\n\n\n\n\n\n\n\n\n\n\n\n

isSiteAdmin (Boolean!)

Whether the user account is a site administrator on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The login of the user account on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

profileName (String)

The profile name of the user account on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

remoteCreatedAt (DateTime!)

The date and time when the user account was created on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

remoteUserId (Int!)

The ID of the user account on the Enterprise Server installation.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountConnection\n

\n

The connection type for EnterpriseServerUserAccount.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerUserAccountEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerUserAccount])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerUserAccount)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmail\n

\n

An email belonging to a user account on an Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String!)

The email address.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrimary (Boolean!)

Indicates whether this is the primary email of the associated user account.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

userAccount (EnterpriseServerUserAccount!)

The user account to which the email belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailConnection\n

\n

The connection type for EnterpriseServerUserAccountEmail.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerUserAccountEmailEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerUserAccountEmail])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountEmailEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerUserAccountEmail)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUpload\n

\n

A user accounts upload from an Enterprise Server installation.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise!)

The enterprise to which this upload belongs.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseServerInstallation (EnterpriseServerInstallation!)

The Enterprise Server installation for which this upload was generated.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the file uploaded.

\n\n\n\n\n\n\n\n\n\n\n\n

syncState (EnterpriseServerUserAccountsUploadSyncState!)

The synchronization state of the upload.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadConnection\n

\n

The connection type for EnterpriseServerUserAccountsUpload.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseServerUserAccountsUploadEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseServerUserAccountsUpload])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseServerUserAccountsUploadEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseServerUserAccountsUpload)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseUserAccount\n

\n

An account for a user who is an admin of an enterprise or a member of an enterprise through one or more organizations.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the enterprise user account's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

enterprise (Enterprise!)

The enterprise in which this user account exists.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

An identifier for the enterprise user account, a login or email address.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the enterprise user account.

\n\n\n\n\n\n\n\n\n\n\n\n

organizations (EnterpriseOrganizationMembershipConnection!)

A list of enterprise organizations this user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (OrganizationOrder)

\n

Ordering options for organizations returned from the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (EnterpriseUserAccountMembershipRole)

\n

The role of the user in the enterprise organization.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user within the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseUserAccountConnection\n

\n

The connection type for EnterpriseUserAccount.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([EnterpriseUserAccountEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([EnterpriseUserAccount])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n EnterpriseUserAccountEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (EnterpriseUserAccount)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentity\n

\n

An external identity provisioned by SAML SSO or SCIM.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

guid (String!)

The GUID for this identity.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationInvitation (OrganizationInvitation)

Organization invitation for this SCIM-provisioned external identity.

\n\n\n\n\n\n\n\n\n\n\n\n

samlIdentity (ExternalIdentitySamlAttributes)

SAML Identity attributes.

\n\n\n\n\n\n\n\n\n\n\n\n

scimIdentity (ExternalIdentityScimAttributes)

SCIM Identity attributes.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

User linked to this external identity. Will be NULL if this identity has not been claimed by an organization member.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentityConnection\n

\n

The connection type for ExternalIdentity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ExternalIdentityEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ExternalIdentity])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentityEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ExternalIdentity)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentitySamlAttributes\n

\n

SAML attributes for the External Identity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([UserEmailMetadata!])

The emails associated with the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

familyName (String)

Family name of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

givenName (String)

Given name of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

groups ([String!])

The groups linked to this identity in IDP.

\n\n\n\n\n\n\n\n\n\n\n\n

nameId (String)

The NameID of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n

username (String)

The userName of the SAML identity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ExternalIdentityScimAttributes\n

\n

SCIM attributes for the External Identity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

emails ([UserEmailMetadata!])

The emails associated with the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n

familyName (String)

Family name of the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n

givenName (String)

Given name of the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n

groups ([String!])

The groups linked to this identity in IDP.

\n\n\n\n\n\n\n\n\n\n\n\n

username (String)

The userName of the SCIM identity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n FollowerConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n FollowingConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GenericHovercardContext\n

\n

A generic hovercard context with a message and icon.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Gist\n

\n

A Gist.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (GistCommentConnection!)

A list of comments associated with the gist.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The gist description.

\n\n\n\n\n\n\n\n\n\n\n\n

files ([GistFile])

The files in this gist.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

limit (Int)

\n

The maximum number of files to return.

\n

The default value is 10.

\n
\n\n
\n

oid (GitObjectID)

\n

The oid of the files to return.

\n\n
\n\n
\n\n\n

forks (GistConnection!)

A list of forks associated with the gist.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (GistOrder)

\n

Ordering options for gists returned from the connection.

\n\n
\n\n
\n\n\n

isFork (Boolean!)

Identifies if the gist is a fork.

\n\n\n\n\n\n\n\n\n\n\n\n

isPublic (Boolean!)

Whether the gist is public or not.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The gist name.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (RepositoryOwner)

The gist owner.

\n\n\n\n\n\n\n\n\n\n\n\n

pushedAt (DateTime)

Identifies when the gist was last pushed to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTML path to this resource.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this Gist.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistComment\n

\n

Represents a comment on an Gist.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the gist.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the comment body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

gist (Gist!)

The associated gist.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistCommentConnection\n

\n

The connection type for GistComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([GistCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([GistComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (GistComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistConnection\n

\n

The connection type for Gist.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([GistEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Gist])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Gist)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GistFile\n

\n

A file in a gist.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

encodedName (String)

The file name encoded to remove characters that are invalid in URL paths.

\n\n\n\n\n\n\n\n\n\n\n\n

encoding (String)

The gist file encoding.

\n\n\n\n\n\n\n\n\n\n\n\n

extension (String)

The file extension from the file name.

\n\n\n\n\n\n\n\n\n\n\n\n

isImage (Boolean!)

Indicates if this file is an image.

\n\n\n\n\n\n\n\n\n\n\n\n

isTruncated (Boolean!)

Whether the file's contents were truncated.

\n\n\n\n\n\n\n\n\n\n\n\n

language (Language)

The programming language this file is written in.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The gist file name.

\n\n\n\n\n\n\n\n\n\n\n\n

size (Int)

The gist file size in bytes.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String)

UTF8 text data or null if the file is binary.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

truncate (Int)

\n

Optionally truncate the returned file to this length.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitActor\n

\n

Represents an actor in a Git commit (ie. an author or committer).

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the author's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

date (GitTimestamp)

The timestamp of the Git action (authoring or committing).

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email in the Git commit.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name in the Git commit.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The GitHub user corresponding to the email field. Null if no such user exists.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitActorConnection\n

\n

The connection type for GitActor.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([GitActorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([GitActor])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitActorEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (GitActor)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GitHubMetadata\n

\n

Represents information about the GitHub instance.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

gitHubServicesSha (GitObjectID!)

Returns a String that's a SHA of github-services.

\n\n\n\n\n\n\n\n\n\n\n\n

isPasswordAuthenticationVerifiable (Boolean!)

Whether or not users are verified.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n GpgSignature\n

\n

Represents a GPG signature on a Commit or Tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String!)

Email used to sign this object.

\n\n\n\n\n\n\n\n\n\n\n\n

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

keyId (String)

Hex-encoded ID of the key that signed this object.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (String!)

ASCII-armored signature header from object.

\n\n\n\n\n\n\n\n\n\n\n\n

signer (User)

GitHub user corresponding to the email signing this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

\n\n\n\n\n\n\n\n\n\n\n\n

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n HeadRefDeletedEvent\n

\n

Represents ahead_ref_deletedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

headRef (Ref)

Identifies the Ref associated with the head_ref_deleted event.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

Identifies the name of the Ref associated with the head_ref_deleted event.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n HeadRefForcePushedEvent\n

\n

Represents ahead_ref_force_pushedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

afterCommit (Commit)

Identifies the after commit SHA for thehead_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

beforeCommit (Commit)

Identifies the before commit SHA for thehead_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Identifies the fully qualified ref name for thehead_ref_force_pushedevent.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n HeadRefRestoredEvent\n

\n

Represents ahead_ref_restoredevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Hovercard\n

\n

Detail needed to display a hovercard for a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

contexts ([HovercardContext!]!)

Each of the contexts for this hovercard.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IpAllowListEntry\n

\n

An IP address or range of addresses that is allowed to access an owner's resources.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowListValue (String!)

A single IP address or range of IP addresses in CIDR notation.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isActive (Boolean!)

Whether the entry is currently active.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The name of the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (IpAllowListOwner!)

The owner of the IP allow list entry.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryConnection\n

\n

The connection type for IpAllowListEntry.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IpAllowListEntryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IpAllowListEntry])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IpAllowListEntryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IpAllowListEntry)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Issue\n

\n

An Issue is a place to discuss ideas, enhancements, tasks, and bugs for a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

activeLockReason (LockReason)

Reason that the conversation was locked.

\n\n\n\n\n\n\n\n\n\n\n\n

assignees (UserConnection!)

A list of Users assigned to this object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the body of the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyResourcePath (URI!)

The http path for this issue body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

Identifies the body of the issue rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyUrl (URI!)

The http URL for this issue body.

\n\n\n\n\n\n\n\n\n\n\n\n

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (IssueCommentConnection!)

A list of comments associated with the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueCommentOrder)

\n

Ordering options for issue comments returned from the connection.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

hovercard (Hovercard!)

The hovercard information for this issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

includeNotificationContexts (Boolean)

\n

Whether or not to include notification contexts.

\n

The default value is true.

\n
\n\n
\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isPinned (Boolean)

Indicates whether or not this issue is currently pinned to the repository issues list.

\n\n\n\n\n\n\n\n\n\n\n\n

isReadByViewer (Boolean)

Is this issue read by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

labels (LabelConnection)

A list of labels associated with the object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

locked (Boolean!)

true if the object is locked.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (Milestone)

Identifies the milestone associated with the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the issue number.

\n\n\n\n\n\n\n\n\n\n\n\n

participants (UserConnection!)

A list of Users that are participating in the Issue conversation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

projectCards (ProjectCardConnection!)

List of project cards associated with this issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

state (IssueState!)

Identifies the state of the issue.

\n\n\n\n\n\n\n\n\n\n\n\n

timeline (IssueTimelineConnection!)

A list of events, comments, commits, etc. associated with the issue.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

timeline is deprecated.

timeline will be removed Use Issue.timelineItems instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Allows filtering timeline events by a since timestamp.

\n\n
\n\n
\n\n\n

timelineItems (IssueTimelineItemsConnection!)

A list of events, comments, commits, etc. associated with the issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

itemTypes ([IssueTimelineItemsItemType!])

\n

Filter timeline items by type.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Filter timeline items by a since timestamp.

\n\n
\n\n
\n

skip (Int)

\n

Skips the first n elements in the list.

\n\n
\n\n
\n\n\n

title (String!)

Identifies the issue title.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueComment\n

\n

Represents a comment on an Issue.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

Returns the pull request associated with the comment, if this comment was made on a\npull request.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this issue comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this issue comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueCommentConnection\n

\n

The connection type for IssueComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IssueComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IssueComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueConnection\n

\n

The connection type for Issue.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Issue])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueContributionsByRepository\n

\n

This aggregates issues opened by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedIssueContributionConnection!)

The issue contributions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the issues were opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Issue)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTemplate\n

\n

A repository issue template.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

about (String)

The template purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String)

The suggested issue body.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The template name.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String)

The suggested issue title.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineConnection\n

\n

The connection type for IssueTimelineItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueTimelineItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IssueTimelineItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IssueTimelineItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineItemsConnection\n

\n

The connection type for IssueTimelineItems.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([IssueTimelineItemsEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

filteredCount (Int!)

Identifies the count of items after applying before and after filters.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([IssueTimelineItems])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageCount (Int!)

Identifies the count of items after applying before/after filters and first/last/skip slicing.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the timeline was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n IssueTimelineItemsEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (IssueTimelineItems)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n JoinedGitHubContribution\n

\n

Represents a user signing up for a GitHub account.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Label\n

\n

A label for categorizing Issues or Milestones with a given Repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

color (String!)

Identifies the label color.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime)

Identifies the date and time when the label was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A brief description of this label.

\n\n\n\n\n\n\n\n\n\n\n\n

isDefault (Boolean!)

Indicates whether or not this is a default label.

\n\n\n\n\n\n\n\n\n\n\n\n

issues (IssueConnection!)

A list of issues associated with this label.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

name (String!)

Identifies the label name.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests associated with this label.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this label.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this label.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime)

Identifies the date and time when the label was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LabelConnection\n

\n

The connection type for Label.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([LabelEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Label])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LabelEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Label)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LabeledEvent\n

\n

Represents alabeledevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

label (Label!)

Identifies the label associated with thelabeledevent.

\n\n\n\n\n\n\n\n\n\n\n\n

labelable (Labelable!)

Identifies the Labelable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Language\n

\n

Represents a given language found in repositories.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

color (String)

The color defined for the current language.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the current language.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LanguageConnection\n

\n

A list of languages associated with the parent.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([LanguageEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Language])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalSize (Int!)

The total size in bytes of files written in that language.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LanguageEdge\n

\n

Represents the language of a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

size (Int!)

The number of bytes of code written in the language.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n License\n

\n

A repository's open source license.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The full text of the license.

\n\n\n\n\n\n\n\n\n\n\n\n

conditions ([LicenseRule]!)

The conditions set by the license.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

A human-readable description of the license.

\n\n\n\n\n\n\n\n\n\n\n\n

featured (Boolean!)

Whether the license should be featured.

\n\n\n\n\n\n\n\n\n\n\n\n

hidden (Boolean!)

Whether the license should be displayed in license pickers.

\n\n\n\n\n\n\n\n\n\n\n\n

implementation (String)

Instructions on how to implement the license.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The lowercased SPDX ID of the license.

\n\n\n\n\n\n\n\n\n\n\n\n

limitations ([LicenseRule]!)

The limitations set by the license.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The license full name specified by https://spdx.org/licenses.

\n\n\n\n\n\n\n\n\n\n\n\n

nickname (String)

Customary short name if applicable (e.g, GPLv3).

\n\n\n\n\n\n\n\n\n\n\n\n

permissions ([LicenseRule]!)

The permissions set by the license.

\n\n\n\n\n\n\n\n\n\n\n\n

pseudoLicense (Boolean!)

Whether the license is a pseudo-license placeholder (e.g., other, no-license).

\n\n\n\n\n\n\n\n\n\n\n\n

spdxId (String)

Short identifier specified by https://spdx.org/licenses.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI)

URL to the license on https://choosealicense.com.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LicenseRule\n

\n

Describes a License's conditions, permissions, and limitations.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

description (String!)

A description of the rule.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The machine-readable rule key.

\n\n\n\n\n\n\n\n\n\n\n\n

label (String!)

The human-readable rule label.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n LockedEvent\n

\n

Represents alockedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (LockReason)

Reason that the conversation was locked (optional).

\n\n\n\n\n\n\n\n\n\n\n\n

lockable (Lockable!)

Object that was locked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Mannequin\n

\n

A placeholder user for attribution of imported data on GitHub.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI!)

A URL pointing to the GitHub App's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The mannequin's email on the source instance.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The username of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTML path to this resource.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The URL to this resource.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MarkedAsDuplicateEvent\n

\n

Represents amarked_as_duplicateevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

canonical (IssueOrPullRequest)

The authoritative issue or pull request which has been duplicated by another.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicate (IssueOrPullRequest)

The issue or pull request which has been marked as a duplicate of another.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Canonical and duplicate belong to different repositories.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MembersCanDeleteReposClearAuditEntry\n

\n

Audit log entry for a members_can_delete_repos.clear event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MembersCanDeleteReposDisableAuditEntry\n

\n

Audit log entry for a members_can_delete_repos.disable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MembersCanDeleteReposEnableAuditEntry\n

\n

Audit log entry for a members_can_delete_repos.enable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MentionedEvent\n

\n

Represents amentionedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MergedEvent\n

\n

Represents amergedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with the merge event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeRef (Ref)

Identifies the Ref associated with the merge event.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeRefName (String!)

Identifies the name of the Ref associated with the merge event.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this merged event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this merged event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Milestone\n

\n

Represents a Milestone object on a given repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

Identifies the actor who created the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

Identifies the description of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

dueOn (DateTime)

Identifies the due date of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

issues (IssueConnection!)

A list of issues associated with the milestone.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

number (Int!)

Identifies the number of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

progressPercentage (Float!)

Identifies the percentage complete for the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests associated with the milestone.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

state (MilestoneState!)

Identifies the state of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

Identifies the title of the milestone.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this milestone.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MilestoneConnection\n

\n

The connection type for Milestone.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([MilestoneEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Milestone])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MilestoneEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Milestone)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MilestonedEvent\n

\n

Represents amilestonedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

milestoneTitle (String!)

Identifies the milestone title associated with themilestonedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (MilestoneItem!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n MovedColumnsInProjectEvent\n

\n

Represents amoved_columns_in_projectevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

previousProjectColumnName (String!)

Column name the issue or pull request was moved from.

\n\n\n\n\n
\n

Preview notice

\n

previousProjectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectCard (ProjectCard)

Project card referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectCard is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name the issue or pull request was moved to.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OauthApplicationCreateAuditEntry\n

\n

Audit log entry for a oauth_application.create event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

applicationUrl (URI)

The application URL of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

callbackUrl (URI)

The callback URL of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

rateLimit (Int)

The rate limit of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

state (OauthApplicationCreateAuditEntryState)

The state of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgAddBillingManagerAuditEntry\n

\n

Audit log entry for a org.add_billing_manager.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationEmail (String)

The email address used to invite a billing manager for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgAddMemberAuditEntry\n

\n

Audit log entry for a org.add_member.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (OrgAddMemberAuditEntryPermission)

The permission level of the member added to the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgBlockUserAuditEntry\n

\n

Audit log entry for a org.block_user.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUser (User)

The blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserName (String)

The username of the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserResourcePath (URI)

The HTTP path for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserUrl (URI)

The HTTP URL for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgConfigDisableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a org.config.disable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgConfigEnableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a org.config.enable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgCreateAuditEntry\n

\n

Audit log entry for a org.create event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

billingPlan (OrgCreateAuditEntryBillingPlan)

The billing plan for the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgDisableOauthAppRestrictionsAuditEntry\n

\n

Audit log entry for a org.disable_oauth_app_restrictions event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgDisableSamlAuditEntry\n

\n

Audit log entry for a org.disable_saml event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

digestMethodUrl (URI)

The SAML provider's digest algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

issuerUrl (URI)

The SAML provider's issuer URL.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethodUrl (URI)

The SAML provider's signature algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

singleSignOnUrl (URI)

The SAML provider's single sign-on URL.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgDisableTwoFactorRequirementAuditEntry\n

\n

Audit log entry for a org.disable_two_factor_requirement event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgEnableOauthAppRestrictionsAuditEntry\n

\n

Audit log entry for a org.enable_oauth_app_restrictions event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgEnableSamlAuditEntry\n

\n

Audit log entry for a org.enable_saml event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

digestMethodUrl (URI)

The SAML provider's digest algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

issuerUrl (URI)

The SAML provider's issuer URL.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethodUrl (URI)

The SAML provider's signature algorithm URL.

\n\n\n\n\n\n\n\n\n\n\n\n

singleSignOnUrl (URI)

The SAML provider's single sign-on URL.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgEnableTwoFactorRequirementAuditEntry\n

\n

Audit log entry for a org.enable_two_factor_requirement event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgInviteMemberAuditEntry\n

\n

Audit log entry for a org.invite_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email address of the organization invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationInvitation (OrganizationInvitation)

The organization invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgInviteToBusinessAuditEntry\n

\n

Audit log entry for a org.invite_to_business event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgOauthAppAccessApprovedAuditEntry\n

\n

Audit log entry for a org.oauth_app_access_approved event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgOauthAppAccessDeniedAuditEntry\n

\n

Audit log entry for a org.oauth_app_access_denied event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgOauthAppAccessRequestedAuditEntry\n

\n

Audit log entry for a org.oauth_app_access_requested event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationName (String)

The name of the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationResourcePath (URI)

The HTTP path for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

oauthApplicationUrl (URI)

The HTTP URL for the OAuth Application.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRemoveBillingManagerAuditEntry\n

\n

Audit log entry for a org.remove_billing_manager event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (OrgRemoveBillingManagerAuditEntryReason)

The reason for the billing manager being removed.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRemoveMemberAuditEntry\n

\n

Audit log entry for a org.remove_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

membershipTypes ([OrgRemoveMemberAuditEntryMembershipType!])

The types of membership the member has with the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (OrgRemoveMemberAuditEntryReason)

The reason for the member being removed.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRemoveOutsideCollaboratorAuditEntry\n

\n

Audit log entry for a org.remove_outside_collaborator event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

membershipTypes ([OrgRemoveOutsideCollaboratorAuditEntryMembershipType!])

The types of membership the outside collaborator has with the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

reason (OrgRemoveOutsideCollaboratorAuditEntryReason)

The reason for the outside collaborator being removed from the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberAuditEntry\n

\n

Audit log entry for a org.restore_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredCustomEmailRoutingsCount (Int)

The number of custom email routings for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredIssueAssignmentsCount (Int)

The number of issue assignments for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredMemberships ([OrgRestoreMemberAuditEntryMembership!])

Restored organization membership objects.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredMembershipsCount (Int)

The number of restored memberships.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredRepositoriesCount (Int)

The number of repositories of the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredRepositoryStarsCount (Int)

The number of starred repositories for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

restoredRepositoryWatchesCount (Int)

The number of watched repositories for the restored member.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberMembershipOrganizationAuditEntryData\n

\n

Metadata for an organization membership for org.restore_member actions.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberMembershipRepositoryAuditEntryData\n

\n

Metadata for a repository membership for org.restore_member actions.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgRestoreMemberMembershipTeamAuditEntryData\n

\n

Metadata for a team membership for org.restore_member actions.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUnblockUserAuditEntry\n

\n

Audit log entry for a org.unblock_user.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUser (User)

The user being unblocked by the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserName (String)

The username of the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserResourcePath (URI)

The HTTP path for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

blockedUserUrl (URI)

The HTTP URL for the blocked user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateDefaultRepositoryPermissionAuditEntry\n

\n

Audit log entry for a org.update_default_repository_permission.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

The new default repository permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permissionWas (OrgUpdateDefaultRepositoryPermissionAuditEntryPermission)

The former default repository permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateMemberAuditEntry\n

\n

Audit log entry for a org.update_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (OrgUpdateMemberAuditEntryPermission)

The new member permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

permissionWas (OrgUpdateMemberAuditEntryPermission)

The former member permission level for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateMemberRepositoryCreationPermissionAuditEntry\n

\n

Audit log entry for a org.update_member_repository_creation_permission event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

canCreateRepositories (Boolean)

Can members create repositories in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (OrgUpdateMemberRepositoryCreationPermissionAuditEntryVisibility)

The permission for visibility level of repositories for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrgUpdateMemberRepositoryInvitationPermissionAuditEntry\n

\n

Audit log entry for a org.update_member_repository_invitation_permission event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

canInviteOutsideCollaboratorsToRepositories (Boolean)

Can outside collaborators be invited to repositories in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Organization\n

\n

An account on GitHub, with one or more owners, that has repositories, members and teams.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

anyPinnableItems (Boolean!)

Determine if this repository owner has any items that can be pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

type (PinnableItemType)

\n

Filter to only a particular kind of pinnable item.

\n\n
\n\n
\n\n\n

auditLog (OrganizationAuditEntryConnection!)

Audit log entries of the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (AuditLogOrder)

\n

Ordering options for the returned audit log entries.

\n\n
\n\n
\n

query (String)

\n

The query string to filter audit entries.

\n\n
\n\n
\n\n\n

avatarUrl (URI!)

A URL pointing to the organization's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The organization's public profile description.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (String)

The organization's public profile description rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The organization's public email.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEnabledSetting (IpAllowListEnabledSettingValue!)

The setting value for whether the organization has an IP allow list enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

ipAllowListEntries (IpAllowListEntryConnection!)

The IP addresses that are allowed to access resources owned by the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IpAllowListEntryOrder)

\n

Ordering options for IP allow list entries returned.

\n\n
\n\n
\n\n\n

isVerified (Boolean!)

Whether the organization has verified its profile email and website, always false on Enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

itemShowcase (ProfileItemShowcase!)

Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The organization's public profile location.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The organization's login name.

\n\n\n\n\n\n\n\n\n\n\n\n

memberStatuses (UserStatusConnection!)

Get the status messages members of this entity have set that are either public or visible only to the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (UserStatusOrder)

\n

Ordering options for user statuses returned from the connection.

\n\n
\n\n
\n\n\n

membersWithRole (OrganizationMemberConnection!)

A list of users who are members of this organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

name (String)

The organization's public profile name.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamResourcePath (URI!)

The HTTP path creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamUrl (URI!)

The HTTP URL creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationBillingEmail (String)

The billing email for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

pendingMembers (UserConnection!)

A list of users who have been invited to join this organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pinnableItems (PinnableItemConnection!)

A list of repositories and gists this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinnable items that are returned.

\n\n
\n\n
\n\n\n

pinnedItems (PinnableItemConnection!)

A list of repositories and gists this profile owner has pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinned items that are returned.

\n\n
\n\n
\n\n\n

pinnedItemsRemaining (Int!)

Returns how many more items this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Find project by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The project number to find.

\n\n
\n\n
\n\n\n

projects (ProjectConnection!)

A list of projects under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ProjectOrder)

\n

Ordering options for projects returned from the connection.

\n\n
\n\n
\n

search (String)

\n

Query to search projects by, currently only searching by name.

\n\n
\n\n
\n

states ([ProjectState!])

\n

A list of states to filter the projects by.

\n\n
\n\n
\n\n\n

projectsResourcePath (URI!)

The HTTP path listing organization's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

projectsUrl (URI!)

The HTTP URL listing organization's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (RepositoryConnection!)

A list of repositories that the user owns.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isFork (Boolean)

\n

If non-null, filters repositories according to whether they are forks of another repository.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

repository (Repository)

Find Repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

Name of Repository to find.

\n\n
\n\n
\n\n\n

requiresTwoFactorAuthentication (Boolean)

When true the organization requires all members, billing managers, and outside\ncollaborators to enable two-factor authentication.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

samlIdentityProvider (OrganizationIdentityProvider)

The Organization's SAML identity providers.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorshipsAsMaintainer (SponsorshipConnection!)

This object's sponsorships as the maintainer.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includePrivate (Boolean)

\n

Whether or not to include private sponsorships in the result set.

\n

The default value is false.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

sponsorshipsAsSponsor (SponsorshipConnection!)

This object's sponsorships as the sponsor.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

team (Team)

Find an organization's team by its slug.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

slug (String!)

\n

The name or slug of the team to find.

\n\n
\n\n
\n\n\n

teams (TeamConnection!)

A list of teams in this organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

ldapMapped (Boolean)

\n

If true, filters teams that are mapped to an LDAP Group (Enterprise only).

\n\n
\n\n
\n

orderBy (TeamOrder)

\n

Ordering options for teams returned from the connection.

\n\n
\n\n
\n

privacy (TeamPrivacy)

\n

If non-null, filters teams according to privacy.

\n\n
\n\n
\n

query (String)

\n

If non-null, filters teams with query on team name and team slug.

\n\n
\n\n
\n

role (TeamRole)

\n

If non-null, filters teams according to whether the viewer is an admin or member on team.

\n\n
\n\n
\n

rootTeamsOnly (Boolean)

\n

If true, restrict to only root teams.

\n

The default value is false.

\n
\n\n
\n

userLogins ([String!])

\n

User logins to filter by.

\n\n
\n\n
\n\n\n

teamsResourcePath (URI!)

The HTTP path listing organization's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsUrl (URI!)

The HTTP URL listing organization's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

twitterUsername (String)

The organization's Twitter username.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAdminister (Boolean!)

Organization is adminable by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanChangePinnedItems (Boolean!)

Can the viewer pin repositories and gists to the profile?.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateRepositories (Boolean!)

Viewer can create repositories on this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateTeams (Boolean!)

Viewer can create teams on this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerIsAMember (Boolean!)

Viewer is an active member of this organization.

\n\n\n\n\n\n\n\n\n\n\n\n

websiteUrl (URI)

The organization's public profile URL.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationAuditEntryConnection\n

\n

The connection type for OrganizationAuditEntry.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationAuditEntryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([OrganizationAuditEntry])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationAuditEntryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (OrganizationAuditEntry)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationConnection\n

\n

The connection type for Organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Organization])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Organization)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationIdentityProvider\n

\n

An Identity Provider configured to provision SAML and SCIM identities for Organizations.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

digestMethod (URI)

The digest algorithm used to sign SAML requests for the Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n\n

externalIdentities (ExternalIdentityConnection!)

External Identities provisioned by this Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

idpCertificate (X509Certificate)

The x509 certificate used by the Identity Provider to sign assertions and responses.

\n\n\n\n\n\n\n\n\n\n\n\n

issuer (String)

The Issuer Entity ID for the SAML Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

Organization this Identity Provider belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

signatureMethod (URI)

The signature algorithm used to sign SAML requests for the Identity Provider.

\n\n\n\n\n\n\n\n\n\n\n\n

ssoUrl (URI)

The URL endpoint for the Identity Provider's SAML SSO.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationInvitation\n

\n

An Invitation for a user to an organization.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String)

The email address of the user invited to the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

invitationType (OrganizationInvitationType!)

The type of invitation that was sent (e.g. email, user).

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (User)

The user who was invited to the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

inviter (User!)

The user who created the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization!)

The organization the invite is for.

\n\n\n\n\n\n\n\n\n\n\n\n

role (OrganizationInvitationRole!)

The user's pending role in the organization (e.g. member, owner).

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationInvitationConnection\n

\n

The connection type for OrganizationInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([OrganizationInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationInvitationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (OrganizationInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationMemberConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([OrganizationMemberEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationMemberEdge\n

\n

Represents a user within an organization.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

hasTwoFactorEnabled (Boolean)

Whether the organization member has two factor enabled or not. Returns null if information is not available to viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

role (OrganizationMemberRole)

The role this user has in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationTeamsHovercardContext\n

\n

An organization teams hovercard context.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

relevantTeams (TeamConnection!)

Teams in this organization the user is a member of that are relevant.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

teamsResourcePath (URI!)

The path for the full team list for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsUrl (URI!)

The URL for the full team list for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

totalTeamCount (Int!)

The total number of teams the user is on in the organization.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n OrganizationsHovercardContext\n

\n

An organization list hovercard context.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

relevantOrganizations (OrganizationConnection!)

Organizations this user is a member of that are relevant.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

totalOrganizationCount (Int!)

The total number of organizations this user is in.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PageInfo\n

\n

Information about pagination in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

endCursor (String)

When paginating forwards, the cursor to continue.

\n\n\n\n\n\n\n\n\n\n\n\n

hasNextPage (Boolean!)

When paginating forwards, are there more items?.

\n\n\n\n\n\n\n\n\n\n\n\n

hasPreviousPage (Boolean!)

When paginating backwards, are there more items?.

\n\n\n\n\n\n\n\n\n\n\n\n

startCursor (String)

When paginating backwards, the cursor to continue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PermissionSource\n

\n

A level of permission and source for a user's access to a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

organization (Organization!)

The organization the repository belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (DefaultRepositoryPermissionField!)

The level of access this source has granted to the user.

\n\n\n\n\n\n\n\n\n\n\n\n

source (PermissionGranter!)

The source of this permission.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnableItemConnection\n

\n

The connection type for PinnableItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PinnableItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PinnableItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnableItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PinnableItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedEvent\n

\n

Represents apinnedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedIssue\n

\n

A Pinned Issue is a issue pinned to a repository's index page.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

The issue that was pinned.

\n\n\n\n\n\n\n\n\n\n\n\n

pinnedBy (Actor!)

The actor that pinned this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository that this issue was pinned to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedIssueConnection\n

\n

The connection type for PinnedIssue.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PinnedIssueEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PinnedIssue])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PinnedIssueEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PinnedIssue)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PrivateRepositoryForkingDisableAuditEntry\n

\n

Audit log entry for a private_repository_forking.disable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PrivateRepositoryForkingEnableAuditEntry\n

\n

Audit log entry for a private_repository_forking.enable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProfileItemShowcase\n

\n

A curatable list of repositories relating to a repository owner, which defaults\nto showing the most popular repositories they own.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

hasPinnedItems (Boolean!)

Whether or not the owner has pinned any repositories or gists.

\n\n\n\n\n\n\n\n\n\n\n\n

items (PinnableItemConnection!)

The repositories and gists in the showcase. If the profile owner has any\npinned items, those will be returned. Otherwise, the profile owner's popular\nrepositories will be returned.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Project\n

\n

Projects manage issues, pull requests and notes within a project owner.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String)

The project's description body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The projects description body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

closed (Boolean!)

true if the object is closed (definition of closed may depend on type).

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

columns (ProjectColumnConnection!)

List of columns in the project.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

The actor who originally created the project.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The project's name.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

The project's number.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (ProjectOwner!)

The project's owner. Currently limited to repositories, organizations, and users.

\n\n\n\n\n\n\n\n\n\n\n\n

pendingCards (ProjectCardConnection!)

List of pending cards in this project.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

progress (ProjectProgress!)

Project progress details.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this project.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectState!)

Whether the project is open or closed.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this project.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectCard\n

\n

A card in a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

column (ProjectColumn)

The project column this card is associated under. A card may only belong to one\nproject column at a time. The column field will be null if the card is created\nin a pending state and has yet to be associated with a column. Once cards are\nassociated with a column, they will not become pending in the future.

\n\n\n\n\n\n\n\n\n\n\n\n

content (ProjectCardItem)

The card content item.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

The actor who created this card.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean!)

Whether the card is archived.

\n\n\n\n\n\n\n\n\n\n\n\n

note (String)

The card note.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project!)

The project that contains this card.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this card.

\n\n\n\n\n\n\n\n\n\n\n\n

state (ProjectCardState)

The state of ProjectCard.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this card.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectCardConnection\n

\n

The connection type for ProjectCard.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ProjectCardEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ProjectCard])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectCardEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ProjectCard)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectColumn\n

\n

A column inside a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cards (ProjectCardConnection!)

List of cards in the column.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The project column's name.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project!)

The project that contains this column.

\n\n\n\n\n\n\n\n\n\n\n\n

purpose (ProjectColumnPurpose)

The semantic purpose of the column.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this project column.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this project column.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectColumnConnection\n

\n

The connection type for ProjectColumn.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ProjectColumnEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ProjectColumn])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectColumnEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ProjectColumn)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectConnection\n

\n

A list of projects associated with the owner.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ProjectEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Project])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Project)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ProjectProgress\n

\n

Project progress stats.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

doneCount (Int!)

The number of done cards.

\n\n\n\n\n\n\n\n\n\n\n\n

donePercentage (Float!)

The percentage of done cards.

\n\n\n\n\n\n\n\n\n\n\n\n

enabled (Boolean!)

Whether progress tracking is enabled and cards with purpose exist for this project.

\n\n\n\n\n\n\n\n\n\n\n\n

inProgressCount (Int!)

The number of in-progress cards.

\n\n\n\n\n\n\n\n\n\n\n\n

inProgressPercentage (Float!)

The percentage of in-progress cards.

\n\n\n\n\n\n\n\n\n\n\n\n

todoCount (Int!)

The number of to do cards.

\n\n\n\n\n\n\n\n\n\n\n\n

todoPercentage (Float!)

The percentage of to do cards.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PublicKey\n

\n

A user's public key.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

accessedAt (DateTime)

The last time this authorization was used to perform an action. Values will be null for keys not owned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime)

Identifies the date and time when the key was created. Keys created before\nMarch 5th, 2014 have inaccurate values. Values will be null for keys not owned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

fingerprint (String!)

The fingerprint for this PublicKey.

\n\n\n\n\n\n\n\n\n\n\n\n

isReadOnly (Boolean)

Whether this PublicKey is read-only or not. Values will be null for keys not owned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n

key (String!)

The public key string.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime)

Identifies the date and time when the key was updated. Keys created before\nMarch 5th, 2014 may have inaccurate values. Values will be null for keys not\nowned by the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PublicKeyConnection\n

\n

The connection type for PublicKey.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PublicKeyEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PublicKey])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PublicKeyEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PublicKey)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequest\n

\n

A repository pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

activeLockReason (LockReason)

Reason that the conversation was locked.

\n\n\n\n\n\n\n\n\n\n\n\n

additions (Int!)

The number of additions in this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

assignees (UserConnection!)

A list of Users assigned to this object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

autoMergeRequest (AutoMergeRequest)

Returns the auto-merge request object if one exists for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRef (Ref)

Identifies the base Ref associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefName (String!)

Identifies the name of the base Ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRefOid (GitObjectID!)

Identifies the oid of the base ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

baseRepository (Repository)

The repository associated with this pull request's base Ref.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

canBeRebased (Boolean!)

Whether or not the pull request is rebaseable.

\n\n\n\n\n
\n

Preview notice

\n

canBeRebased is available under the Merge info preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

changedFiles (Int!)

The number of changed files in this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

checksResourcePath (URI!)

The HTTP path for the checks of this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

checksUrl (URI!)

The HTTP URL for the checks of this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

closed (Boolean!)

true if the pull request is closed.

\n\n\n\n\n\n\n\n\n\n\n\n

closedAt (DateTime)

Identifies the date and time when the object was closed.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (IssueCommentConnection!)

A list of comments associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueCommentOrder)

\n

Ordering options for issue comments returned from the connection.

\n\n
\n\n
\n\n\n

commits (PullRequestCommitConnection!)

A list of commits present in this pull request's head branch not present in the base branch.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions (Int!)

The number of deletions in this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited this pull request's body.

\n\n\n\n\n\n\n\n\n\n\n\n

files (PullRequestChangedFileConnection)

Lists the files changed within this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

headRef (Ref)

Identifies the head Ref associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefName (String!)

Identifies the name of the head Ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

headRefOid (GitObjectID!)

Identifies the oid of the head ref associated with the pull request, even if the ref has been deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

headRepository (Repository)

The repository associated with this pull request's head Ref.

\n\n\n\n\n\n\n\n\n\n\n\n

headRepositoryOwner (RepositoryOwner)

The owner of the repository associated with this pull request's head Ref.

\n\n\n\n\n\n\n\n\n\n\n\n

hovercard (Hovercard!)

The hovercard information for this issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

includeNotificationContexts (Boolean)

\n

Whether or not to include notification contexts.

\n

The default value is true.

\n
\n\n
\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

The head and base repositories are different.

\n\n\n\n\n\n\n\n\n\n\n\n

isDraft (Boolean!)

Identifies if the pull request is a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

isReadByViewer (Boolean)

Is this pull request read by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

labels (LabelConnection)

A list of labels associated with the object.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

latestOpinionatedReviews (PullRequestReviewConnection)

A list of latest reviews per user associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

writersOnly (Boolean)

\n

Only return reviews from user who have write access to the repository.

\n

The default value is false.

\n
\n\n
\n\n\n

latestReviews (PullRequestReviewConnection)

A list of latest reviews per user associated with the pull request that are not also pending review.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

locked (Boolean!)

true if the pull request is locked.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainerCanModify (Boolean!)

Indicates whether maintainers can modify the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeCommit (Commit)

The commit that was created when this pull request was merged.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeStateStatus (MergeStateStatus!)

Detailed information about the current pull request merge state status.

\n\n\n\n\n
\n

Preview notice

\n

mergeStateStatus is available under the Merge info preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

mergeable (MergeableState!)

Whether or not the pull request can be merged based on the existence of merge conflicts.

\n\n\n\n\n\n\n\n\n\n\n\n

merged (Boolean!)

Whether or not the pull request was merged.

\n\n\n\n\n\n\n\n\n\n\n\n

mergedAt (DateTime)

The date and time that the pull request was merged.

\n\n\n\n\n\n\n\n\n\n\n\n

mergedBy (Actor)

The actor who merged the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (Milestone)

Identifies the milestone associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the pull request number.

\n\n\n\n\n\n\n\n\n\n\n\n

participants (UserConnection!)

A list of Users that are participating in the Pull Request conversation.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

permalink (URI!)

The permalink to the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

potentialMergeCommit (Commit)

The commit that GitHub automatically generated to test if this pull request\ncould be merged. This field will not return a value if the pull request is\nmerged, or if the test merge commit is still being generated. See the\nmergeable field for more details on the mergeability of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

projectCards (ProjectCardConnection!)

List of project cards associated with this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

archivedStates ([ProjectCardArchivedState])

\n

A list of archived states to filter the cards by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

revertResourcePath (URI!)

The HTTP path for reverting this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

revertUrl (URI!)

The HTTP URL for reverting this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDecision (PullRequestReviewDecision)

The current status of this pull request with respect to code review.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewRequests (ReviewRequestConnection)

A list of review requests associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

reviewThreads (PullRequestReviewThreadConnection!)

The list of all review threads for this pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

reviews (PullRequestReviewConnection)

A list of reviews associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

author (String)

\n

Filter by author of the review.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

states ([PullRequestReviewState!])

\n

A list of states to filter the reviews.

\n\n
\n\n
\n\n\n

state (PullRequestState!)

Identifies the state of the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

suggestedReviewers ([SuggestedReviewer]!)

A list of reviewer suggestions based on commit history and past review comments.

\n\n\n\n\n\n\n\n\n\n\n\n

timeline (PullRequestTimelineConnection!)

A list of events, comments, commits, etc. associated with the pull request.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

timeline is deprecated.

timeline will be removed Use PullRequest.timelineItems instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Allows filtering timeline events by a since timestamp.

\n\n
\n\n
\n\n\n

timelineItems (PullRequestTimelineItemsConnection!)

A list of events, comments, commits, etc. associated with the pull request.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

itemTypes ([PullRequestTimelineItemsItemType!])

\n

Filter timeline items by type.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

since (DateTime)

\n

Filter timeline items by a since timestamp.

\n\n
\n\n
\n

skip (Int)

\n

Skips the first n elements in the list.

\n\n
\n\n
\n\n\n

title (String!)

Identifies the pull request title.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanApplySuggestion (Boolean!)

Whether or not the viewer can apply suggestion.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanDeleteHeadRef (Boolean!)

Check if the viewer can restore the deleted head ref.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanDisableAutoMerge (Boolean!)

Whether or not the viewer can disable auto-merge.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanEnableAutoMerge (Boolean!)

Whether or not the viewer can enable auto-merge.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerMergeBodyText (String!)

The merge body text for the viewer and method.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

mergeType (PullRequestMergeMethod)

\n

The merge method for the message.

\n\n
\n\n
\n\n\n

viewerMergeHeadlineText (String!)

The merge headline text for the viewer and method.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

mergeType (PullRequestMergeMethod)

\n

The merge method for the message.

\n\n
\n\n
\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestChangedFile\n

\n

A file changed in a pull request.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

additions (Int!)

The number of additions to the file.

\n\n\n\n\n\n\n\n\n\n\n\n

deletions (Int!)

The number of deletions to the file.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerViewedState (FileViewedState!)

The state of the file for the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestChangedFileConnection\n

\n

The connection type for PullRequestChangedFile.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestChangedFileEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestChangedFile])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestChangedFileEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestChangedFile)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommit\n

\n

Represents a Git commit part of a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commit (Commit!)

The Git commit object.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request this commit belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this pull request commit.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this pull request commit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommitCommentThread\n

\n

Represents a commit comment thread part of a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (CommitCommentConnection!)

The comments that exist in this thread.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit!)

The commit the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The file the comments were made on.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The position in the diff for the commit that the comment was made on.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request this commit comment thread belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommitConnection\n

\n

The connection type for PullRequestCommit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestCommitEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestCommit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestCommitEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestCommit)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestConnection\n

\n

The connection type for PullRequest.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequest])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestContributionsByRepository\n

\n

This aggregates pull requests opened by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedPullRequestContributionConnection!)

The pull request contributions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the pull requests were opened.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequest)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReview\n

\n

A review object for a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorCanPushToRepository (Boolean!)

Indicates whether the author of this review has push access to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

Identifies the pull request review body.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body of this review rendered as plain text.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (PullRequestReviewCommentConnection!)

A list of review comments for the current pull request review.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit)

Identifies the commit associated with this pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

onBehalfOf (TeamConnection!)

A list of teams that this review was made on behalf of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

Identifies the pull request associated with this pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path permalink for this PullRequestReview.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestReviewState!)

Identifies the current state of the pull request review.

\n\n\n\n\n\n\n\n\n\n\n\n

submittedAt (DateTime)

Identifies when the Pull Request Review was submitted.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL permalink for this PullRequestReview.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewComment\n

\n

A review comment associated with a given repository pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the subject of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The comment body of this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The comment body of this review comment rendered as plain text.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies when the comment was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

diffHunk (String!)

The diff hunk to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

draftedAt (DateTime!)

Identifies when the comment was created in a draft state.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isMinimized (Boolean!)

Returns whether or not a comment has been minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

minimizedReason (String)

Returns why the comment was minimized.

\n\n\n\n\n\n\n\n\n\n\n\n

originalCommit (Commit)

Identifies the original commit associated with the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

originalPosition (Int!)

The original line index in the diff to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

outdated (Boolean!)

Identifies when the comment body is outdated.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

position (Int)

The line index in the diff to which the comment applies.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request associated with this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestReview (PullRequestReview)

The pull request review associated with this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

replyTo (PullRequestReviewComment)

The comment this is a reply to.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository associated with this node.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path permalink for this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

state (PullRequestReviewCommentState!)

Identifies the state of the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies when the comment was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL permalink for this review comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanMinimize (Boolean!)

Check if the current viewer can minimize this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewCommentConnection\n

\n

The connection type for PullRequestReviewComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestReviewCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestReviewComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestReviewComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewConnection\n

\n

The connection type for PullRequestReview.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestReviewEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestReview])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewContributionsByRepository\n

\n

This aggregates pull request reviews made by a user within one repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contributions (CreatedPullRequestReviewContributionConnection!)

The pull request review contributions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ContributionOrder)

\n

Ordering options for contributions returned from the connection.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository in which the pull request reviews were made.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestReview)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewThread\n

\n

A threaded list of comments for a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

comments (PullRequestReviewCommentConnection!)

A list of pull request comments associated with the thread.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

skip (Int)

\n

Skips the first n elements in the list.

\n\n
\n\n
\n\n\n

diffSide (DiffSide!)

The side of the diff on which this thread was placed.

\n\n\n\n\n\n\n\n\n\n\n\n

isCollapsed (Boolean!)

Whether or not the thread has been collapsed (outdated or resolved).

\n\n\n\n\n\n\n\n\n\n\n\n

isOutdated (Boolean!)

Indicates whether this thread was outdated by newer changes.

\n\n\n\n\n\n\n\n\n\n\n\n

isResolved (Boolean!)

Whether this thread has been resolved.

\n\n\n\n\n\n\n\n\n\n\n\n

line (Int)

The line in the file to which this thread refers.

\n\n\n\n\n\n\n\n\n\n\n\n

originalLine (Int)

The original line in the file to which this thread refers.

\n\n\n\n\n\n\n\n\n\n\n\n

originalStartLine (Int)

The original start line in the file to which this thread refers (multi-line only).

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

Identifies the file path of this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

Identifies the pull request associated with this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

Identifies the repository associated with this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

resolvedBy (User)

The user who resolved this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

startDiffSide (DiffSide)

The side of the diff that the first line of the thread starts on (multi-line only).

\n\n\n\n\n\n\n\n\n\n\n\n

startLine (Int)

The start line in the file to which this thread refers (multi-line only).

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReply (Boolean!)

Indicates whether the current viewer can reply to this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanResolve (Boolean!)

Whether or not the viewer can resolve this thread.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUnresolve (Boolean!)

Whether or not the viewer can unresolve this thread.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewThreadConnection\n

\n

Review comment threads for a pull request review.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestReviewThreadEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestReviewThread])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestReviewThreadEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestReviewThread)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestRevisionMarker\n

\n

Represents the latest point in the pull request timeline for which the viewer has seen the pull request's commits.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

lastSeenCommit (Commit!)

The last commit the viewer has seen.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

The pull request to which the marker belongs.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineConnection\n

\n

The connection type for PullRequestTimelineItem.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestTimelineItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestTimelineItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestTimelineItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineItemsConnection\n

\n

The connection type for PullRequestTimelineItems.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PullRequestTimelineItemsEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

filteredCount (Int!)

Identifies the count of items after applying before and after filters.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PullRequestTimelineItems])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageCount (Int!)

Identifies the count of items after applying before/after filters and first/last/skip slicing.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the timeline was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PullRequestTimelineItemsEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PullRequestTimelineItems)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Push\n

\n

A Git push.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

nextSha (GitObjectID)

The SHA after the push.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI!)

The permalink for this push.

\n\n\n\n\n\n\n\n\n\n\n\n

previousSha (GitObjectID)

The SHA before the push.

\n\n\n\n\n\n\n\n\n\n\n\n

pusher (User!)

The user who pushed.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository that was pushed to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PushAllowance\n

\n

A team, user or app who has the ability to push to a protected branch.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (PushAllowanceActor)

The actor that can push.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule associated with the allowed user or team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PushAllowanceConnection\n

\n

The connection type for PushAllowance.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([PushAllowanceEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([PushAllowance])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n PushAllowanceEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (PushAllowance)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RateLimit\n

\n

Represents the client's rate limit.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cost (Int!)

The point cost for the current query counting against the rate limit.

\n\n\n\n\n\n\n\n\n\n\n\n

limit (Int!)

The maximum number of points the client is permitted to consume in a 60 minute window.

\n\n\n\n\n\n\n\n\n\n\n\n

nodeCount (Int!)

The maximum number of nodes this query may return.

\n\n\n\n\n\n\n\n\n\n\n\n

remaining (Int!)

The number of points remaining in the current rate limit window.

\n\n\n\n\n\n\n\n\n\n\n\n

resetAt (DateTime!)

The time at which the current rate limit window resets in UTC epoch seconds.

\n\n\n\n\n\n\n\n\n\n\n\n

used (Int!)

The number of points used in the current rate limit window.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactingUserConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReactingUserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactingUserEdge\n

\n

Represents a user that's made a reaction.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

reactedAt (DateTime!)

The moment when the user made the reaction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Reaction\n

\n

An emoji reaction to a particular piece of content.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

content (ReactionContent!)

Identifies the emoji reaction.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

reactable (Reactable!)

The reactable piece of content.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

Identifies the user who created this reaction.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactionConnection\n

\n

A list of reactions that have been left on the subject.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReactionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Reaction])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasReacted (Boolean!)

Whether or not the authenticated user has left a reaction on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Reaction)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReactionGroup\n

\n

A group of emoji reactions to a particular piece of content.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

content (ReactionContent!)

Identifies the emoji reaction.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime)

Identifies when the reaction was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (Reactable!)

The subject that was reacted to.

\n\n\n\n\n\n\n\n\n\n\n\n

users (ReactingUserConnection!)

Users who have reacted to the reaction subject with the emotion represented by this reaction group.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerHasReacted (Boolean!)

Whether or not the authenticated user has left a reaction on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReadyForReviewEvent\n

\n

Represents aready_for_reviewevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this ready for review event.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this ready for review event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Ref\n

\n

Represents a Git reference.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

associatedPullRequests (PullRequestConnection!)

A list of pull requests with this ref as the head ref.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

branchProtectionRule (BranchProtectionRule)

Branch protection rules for this ref.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The ref name.

\n\n\n\n\n\n\n\n\n\n\n\n

prefix (String!)

The ref's prefix, such as refs/heads/ or refs/tags/.

\n\n\n\n\n\n\n\n\n\n\n\n

refUpdateRule (RefUpdateRule)

Branch protection rules that are viewable by non-admins.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The repository the ref belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

target (GitObject)

The object the ref points to. Returns null when object does not exist.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RefConnection\n

\n

The connection type for Ref.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RefEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Ref])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RefEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Ref)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RefUpdateRule\n

\n

A ref update rules for a viewer.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

allowsDeletions (Boolean!)

Can this branch be deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

allowsForcePushes (Boolean!)

Are force pushes allowed on this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

pattern (String!)

Identifies the protection rule pattern.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredApprovingReviewCount (Int)

Number of approving reviews required to update matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiredStatusCheckContexts ([String])

List of required status check contexts that must pass for commits to be accepted to matching branches.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresLinearHistory (Boolean!)

Are merge commits prohibited from being pushed to this branch.

\n\n\n\n\n\n\n\n\n\n\n\n

requiresSignatures (Boolean!)

Are commits required to be signed.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanPush (Boolean!)

Can the viewer push to the branch.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReferencedEvent\n

\n

Represents areferencedevent on a given ReferencedSubject.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

commit (Commit)

Identifies the commit associated with thereferencedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

commitRepository (Repository!)

Identifies the repository associated with thereferencedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Reference originated in a different repository.

\n\n\n\n\n\n\n\n\n\n\n\n

isDirectReference (Boolean!)

Checks if the commit message itself references the subject. Can be false in the case of a commit comment reference.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (ReferencedSubject!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Release\n

\n

A release contains the content for a release.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (User)

The author of the release.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the release.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML)

The description of this release rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

isDraft (Boolean!)

Whether or not the release is a draft.

\n\n\n\n\n\n\n\n\n\n\n\n

isLatest (Boolean!)

Whether or not the release is the latest releast.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrerelease (Boolean!)

Whether or not the release is a prerelease.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The title of the release.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies the date and time when the release was created.

\n\n\n\n\n\n\n\n\n\n\n\n

releaseAssets (ReleaseAssetConnection!)

List of releases assets which are dependent on this release.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

name (String)

\n

A list of names to filter the assets by.

\n\n
\n\n
\n\n\n

repository (Repository!)

The repository that the release belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n

shortDescriptionHTML (HTML)

A description of the release, rendered to HTML without any links in it.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

limit (Int)

\n

How many characters to return.

\n

The default value is 200.

\n
\n\n
\n\n\n

tag (Ref)

The Git tag the release points to.

\n\n\n\n\n\n\n\n\n\n\n\n

tagCommit (Commit)

The tag commit for this release.

\n\n\n\n\n\n\n\n\n\n\n\n

tagName (String!)

The name of the release's Git tag.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this issue.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseAsset\n

\n

A release asset contains the content for a release asset.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

contentType (String!)

The asset's content-type.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

downloadCount (Int!)

The number of times this asset was downloaded.

\n\n\n\n\n\n\n\n\n\n\n\n

downloadUrl (URI!)

Identifies the URL where you can download the release asset via the browser.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Identifies the title of the release asset.

\n\n\n\n\n\n\n\n\n\n\n\n

release (Release)

Release that the asset is associated with.

\n\n\n\n\n\n\n\n\n\n\n\n

size (Int!)

The size (in bytes) of the asset.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

uploadedBy (User!)

The user that performed the upload.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

Identifies the URL of the release asset.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseAssetConnection\n

\n

The connection type for ReleaseAsset.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReleaseAssetEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ReleaseAsset])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseAssetEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ReleaseAsset)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseConnection\n

\n

The connection type for Release.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReleaseEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Release])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReleaseEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Release)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RemovedFromProjectEvent\n

\n

Represents aremoved_from_projectevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Project referenced by event.

\n\n\n\n\n
\n

Preview notice

\n

project is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

projectColumnName (String!)

Column name referenced by this project event.

\n\n\n\n\n
\n

Preview notice

\n

projectColumnName is available under the Project event details preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RenamedTitleEvent\n

\n

Represents arenamedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

currentTitle (String!)

Identifies the current title of the issue or pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

previousTitle (String!)

Identifies the previous title of the issue or pull request.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (RenamedTitleSubject!)

Subject that was renamed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReopenedEvent\n

\n

Represents areopenedevent on any Closable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

closable (Closable!)

Object that was reopened.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoAccessAuditEntry\n

\n

Audit log entry for a repo.access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoAccessAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoAddMemberAuditEntry\n

\n

Audit log entry for a repo.add_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoAddMemberAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoAddTopicAuditEntry\n

\n

Audit log entry for a repo.add_topic event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topic (Topic)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicName (String)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoArchivedAuditEntry\n

\n

Audit log entry for a repo.archived event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoArchivedAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoChangeMergeSettingAuditEntry\n

\n

Audit log entry for a repo.change_merge_setting event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isEnabled (Boolean)

Whether the change was to enable (true) or disable (false) the merge type.

\n\n\n\n\n\n\n\n\n\n\n\n

mergeType (RepoChangeMergeSettingAuditEntryMergeType)

The merge method affected by the change.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.disable_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.disable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableContributorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.disable_contributors_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigDisableSockpuppetDisallowedAuditEntry\n

\n

Audit log entry for a repo.config.disable_sockpuppet_disallowed event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.enable_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableCollaboratorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.enable_collaborators_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableContributorsOnlyAuditEntry\n

\n

Audit log entry for a repo.config.enable_contributors_only event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigEnableSockpuppetDisallowedAuditEntry\n

\n

Audit log entry for a repo.config.enable_sockpuppet_disallowed event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigLockAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.lock_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoConfigUnlockAnonymousGitAccessAuditEntry\n

\n

Audit log entry for a repo.config.unlock_anonymous_git_access event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoCreateAuditEntry\n

\n

Audit log entry for a repo.create event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

forkParentName (String)

The name of the parent repository for this forked repository.

\n\n\n\n\n\n\n\n\n\n\n\n

forkSourceName (String)

The name of the root repository for this network.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoCreateAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoDestroyAuditEntry\n

\n

Audit log entry for a repo.destroy event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoDestroyAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoRemoveMemberAuditEntry\n

\n

Audit log entry for a repo.remove_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

visibility (RepoRemoveMemberAuditEntryVisibility)

The visibility of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepoRemoveTopicAuditEntry\n

\n

Audit log entry for a repo.remove_topic event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topic (Topic)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

topicName (String)

The name of the topic added to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Repository\n

\n

A repository contains the content for a project.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

assignableUsers (UserConnection!)

A list of users that can be assigned to issues in this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters users with query on user name and login.

\n\n
\n\n
\n\n\n

branchProtectionRules (BranchProtectionRuleConnection!)

A list of branch protection rules for this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

codeOfConduct (CodeOfConduct)

Returns the code of conduct for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

collaborators (RepositoryCollaboratorConnection)

A list of collaborators associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliation (CollaboratorAffiliation)

\n

Collaborators affiliation level with a repository.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters users with query on user name and login.

\n\n
\n\n
\n\n\n

commitComments (CommitCommentConnection!)

A list of commit comments associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

contactLinks ([RepositoryContactLink!])

Returns a list of contact links associated to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

defaultBranchRef (Ref)

The Ref associated with the repository's default branch.

\n\n\n\n\n\n\n\n\n\n\n\n

deleteBranchOnMerge (Boolean!)

Whether or not branches are automatically deleted when merged in this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

deployKeys (DeployKeyConnection!)

A list of deploy keys that are on this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

deployments (DeploymentConnection!)

Deployments associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

environments ([String!])

\n

Environments to list deployments for.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (DeploymentOrder)

\n

Ordering options for deployments returned from the connection.

\n\n
\n\n
\n\n\n

description (String)

The description of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

descriptionHTML (HTML!)

The description of the repository rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

diskUsage (Int)

The number of kilobytes this repository occupies on disk.

\n\n\n\n\n\n\n\n\n\n\n\n

forkCount (Int!)

Returns how many forks there are of this repository in the whole network.

\n\n\n\n\n\n\n\n\n\n\n\n

forks (RepositoryConnection!)

A list of direct forked repositories.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

hasAnonymousAccessEnabled (Boolean!)

Indicates if the repository has anonymous Git read access feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasIssuesEnabled (Boolean!)

Indicates if the repository has issues feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasProjectsEnabled (Boolean!)

Indicates if the repository has the Projects feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

hasWikiEnabled (Boolean!)

Indicates if the repository has wiki feature enabled.

\n\n\n\n\n\n\n\n\n\n\n\n

homepageUrl (URI)

The repository's URL.

\n\n\n\n\n\n\n\n\n\n\n\n

isArchived (Boolean!)

Indicates if the repository is unmaintained.

\n\n\n\n\n\n\n\n\n\n\n\n

isBlankIssuesEnabled (Boolean!)

Returns true if blank issue creation is allowed.

\n\n\n\n\n\n\n\n\n\n\n\n

isDisabled (Boolean!)

Returns whether or not this repository disabled.

\n\n\n\n\n\n\n\n\n\n\n\n

isEmpty (Boolean!)

Returns whether or not this repository is empty.

\n\n\n\n\n\n\n\n\n\n\n\n

isFork (Boolean!)

Identifies if the repository is a fork.

\n\n\n\n\n\n\n\n\n\n\n\n

isInOrganization (Boolean!)

Indicates if a repository is either owned by an organization, or is a private fork of an organization repository.

\n\n\n\n\n\n\n\n\n\n\n\n

isLocked (Boolean!)

Indicates if the repository has been locked or not.

\n\n\n\n\n\n\n\n\n\n\n\n

isMirror (Boolean!)

Identifies if the repository is a mirror.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrivate (Boolean!)

Identifies if the repository is private.

\n\n\n\n\n\n\n\n\n\n\n\n

isSecurityPolicyEnabled (Boolean)

Returns true if this repository has a security policy.

\n\n\n\n\n\n\n\n\n\n\n\n

isTemplate (Boolean!)

Identifies if the repository is a template that can be used to generate new repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

isUserConfigurationRepository (Boolean!)

Is this repository a user configuration repository?.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue)

Returns a single issue from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the issue to be returned.

\n\n
\n\n
\n\n\n

issueOrPullRequest (IssueOrPullRequest)

Returns a single issue-like object from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the issue to be returned.

\n\n
\n\n
\n\n\n

issueTemplates ([IssueTemplate!])

Returns a list of issue templates associated to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

issues (IssueConnection!)

A list of issues that have been opened in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

label (Label)

Returns a single label by name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

Label name.

\n\n
\n\n
\n\n\n

labels (LabelConnection)

A list of labels associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LabelOrder)

\n

Ordering options for labels returned from the connection.

\n\n
\n\n
\n

query (String)

\n

If provided, searches labels by name and description.

\n\n
\n\n
\n\n\n

languages (LanguageConnection)

A list containing a breakdown of the language composition of the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (LanguageOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

latestRelease (Release)

Get the latest release for the repository if one exists.

\n\n\n\n\n\n\n\n\n\n\n\n

licenseInfo (License)

The license associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

lockReason (RepositoryLockReason)

The reason the repository has been locked.

\n\n\n\n\n\n\n\n\n\n\n\n

mentionableUsers (UserConnection!)

A list of Users that can be mentioned in the context of the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

query (String)

\n

Filters users with query on user name and login.

\n\n
\n\n
\n\n\n

mergeCommitAllowed (Boolean!)

Whether or not PRs are merged with a merge commit on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

milestone (Milestone)

Returns a single milestone from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the milestone to be returned.

\n\n
\n\n
\n\n\n

milestones (MilestoneConnection)

A list of milestones associated with the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (MilestoneOrder)

\n

Ordering options for milestones.

\n\n
\n\n
\n

query (String)

\n

Filters milestones with a query on the title.

\n\n
\n\n
\n

states ([MilestoneState!])

\n

Filter by the state of the milestones.

\n\n
\n\n
\n\n\n

mirrorUrl (URI)

The repository's original mirror URL.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

nameWithOwner (String!)

The repository's name with owner.

\n\n\n\n\n\n\n\n\n\n\n\n

object (GitObject)

A Git object in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

expression (String)

\n

A Git revision expression suitable for rev-parse.

\n\n
\n\n
\n

oid (GitObjectID)

\n

The Git object ID.

\n\n
\n\n
\n\n\n

openGraphImageUrl (URI!)

The image used to represent this repository in Open Graph data.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (RepositoryOwner!)

The User owner of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

parent (Repository)

The repository parent, if this is a fork.

\n\n\n\n\n\n\n\n\n\n\n\n

pinnedIssues (PinnedIssueConnection)

A list of pinned issues for this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

primaryLanguage (Language)

The primary language of the repository's code.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Find project by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The project number to find.

\n\n
\n\n
\n\n\n

projects (ProjectConnection!)

A list of projects under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ProjectOrder)

\n

Ordering options for projects returned from the connection.

\n\n
\n\n
\n

search (String)

\n

Query to search projects by, currently only searching by name.

\n\n
\n\n
\n

states ([ProjectState!])

\n

A list of states to filter the projects by.

\n\n
\n\n
\n\n\n

projectsResourcePath (URI!)

The HTTP path listing the repository's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

projectsUrl (URI!)

The HTTP URL listing the repository's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest)

Returns a single pull request from the current repository by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The number for the pull request to be returned.

\n\n
\n\n
\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests that have been opened in the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

pushedAt (DateTime)

Identifies when the repository was last pushed to.

\n\n\n\n\n\n\n\n\n\n\n\n

rebaseMergeAllowed (Boolean!)

Whether or not rebase-merging is enabled on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

ref (Ref)

Fetch a given ref from the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

qualifiedName (String!)

\n

The ref to retrieve. Fully qualified matches are checked in order\n(refs/heads/master) before falling back onto checks for short name matches (master).

\n\n
\n\n
\n\n\n

refs (RefConnection)

Fetch a list of refs from the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

direction (OrderDirection)

\n

DEPRECATED: use orderBy. The ordering direction.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RefOrder)

\n

Ordering options for refs returned from the connection.

\n\n
\n\n
\n

query (String)

\n

Filters refs with query on name.

\n\n
\n\n
\n

refPrefix (String!)

\n

A ref name prefix like refs/heads/, refs/tags/, etc.

\n\n
\n\n
\n\n\n

release (Release)

Lookup a single release given various criteria.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

tagName (String!)

\n

The name of the Tag the Release was created from.

\n\n
\n\n
\n\n\n

releases (ReleaseConnection!)

List of releases which are dependent on this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReleaseOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

repositoryTopics (RepositoryTopicConnection!)

A list of applied repository-topic associations for this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

securityPolicyUrl (URI)

The security policy URL.

\n\n\n\n\n\n\n\n\n\n\n\n

shortDescriptionHTML (HTML!)

A description of the repository, rendered to HTML without any links in it.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

limit (Int)

\n

How many characters to return.

\n

The default value is 200.

\n
\n\n
\n\n\n

squashMergeAllowed (Boolean!)

Whether or not squash-merging is enabled on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

sshUrl (GitSSHRemote!)

The SSH URL to clone this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

submodules (SubmoduleConnection!)

Returns a list of all submodules in this repository parsed from the\n.gitmodules file as of the default branch's HEAD commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

tempCloneToken (String)

Temporary authentication token for cloning this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

templateRepository (Repository)

The repository from which this repository was generated, if any.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

usesCustomOpenGraphImage (Boolean!)

Whether this repository has a custom image to use with Open Graph as opposed to being represented by the owner's avatar.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAdminister (Boolean!)

Indicates whether the viewer has admin permissions on this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdateTopics (Boolean!)

Indicates whether the viewer can update the topics of this repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDefaultCommitEmail (String)

The last commit email for the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDefaultMergeMethod (PullRequestMergeMethod!)

The last used merge method by the viewer or the default for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerPermission (RepositoryPermission)

The users permission level on the repository. Will return null if authenticated as an GitHub App.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerPossibleCommitEmails ([String!])

A list of emails this viewer can commit with.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerabilityAlerts (RepositoryVulnerabilityAlertConnection)

A list of vulnerability alerts that are on this repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

watchers (UserConnection!)

A list of users watching the repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryCollaboratorConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryCollaboratorEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryCollaboratorEdge\n

\n

Represents a user who is a collaborator of a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (RepositoryPermission!)

The permission the user has on the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

permissionSources ([PermissionSource!])

A list of sources for the user's access to the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryConnection\n

\n

A list of repositories owned by the subject.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Repository])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n

totalDiskUsage (Int!)

The total size in kilobytes of all repositories in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryContactLink\n

\n

A repository contact link.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

about (String!)

The contact link purpose.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The contact link name.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The contact link URL.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Repository)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInvitation\n

\n

An invitation for a user to be added to a repository.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String)

The email address that received the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

invitee (User)

The user who received the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

inviter (User!)

The user who created the invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI!)

The permalink for this repository invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (RepositoryPermission!)

The permission granted on this repository by this invitation.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (RepositoryInfo)

The Repository the user is invited to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationConnection\n

\n

The connection type for RepositoryInvitation.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryInvitationEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([RepositoryInvitation])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryInvitationEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (RepositoryInvitation)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryTopic\n

\n

A repository-topic connects a repository to a topic.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

resourcePath (URI!)

The HTTP path for this repository-topic.

\n\n\n\n\n\n\n\n\n\n\n\n

topic (Topic!)

The topic.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this repository-topic.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryTopicConnection\n

\n

The connection type for RepositoryTopic.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryTopicEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([RepositoryTopic])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryTopicEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (RepositoryTopic)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVisibilityChangeDisableAuditEntry\n

\n

Audit log entry for a repository_visibility_change.disable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVisibilityChangeEnableAuditEntry\n

\n

Audit log entry for a repository_visibility_change.enable event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseResourcePath (URI)

The HTTP path for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseSlug (String)

The slug of the enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

enterpriseUrl (URI)

The HTTP URL for this enterprise.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVulnerabilityAlert\n

\n

A alert for a repository with an affected vulnerability.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

When was the alert created?.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissReason (String)

The reason the alert was dismissed.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissedAt (DateTime)

When was the alert dismissed?.

\n\n\n\n\n\n\n\n\n\n\n\n

dismisser (User)

The user who dismissed the alert.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The associated repository.

\n\n\n\n\n\n\n\n\n\n\n\n

securityAdvisory (SecurityAdvisory)

The associated security advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

securityVulnerability (SecurityVulnerability)

The associated security vulnerability.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableManifestFilename (String!)

The vulnerable manifest filename.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableManifestPath (String!)

The vulnerable manifest path.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableRequirements (String)

The vulnerable requirements.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVulnerabilityAlertConnection\n

\n

The connection type for RepositoryVulnerabilityAlert.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([RepositoryVulnerabilityAlertEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([RepositoryVulnerabilityAlert])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RepositoryVulnerabilityAlertEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (RepositoryVulnerabilityAlert)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n RestrictedContribution\n

\n

Represents a private contribution a user made on GitHub.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isRestricted (Boolean!)

Whether this contribution is associated with a record you do not have access to. For\nexample, your own 'first issue' contribution may have been made on a repository you can no\nlonger access.

\n\n\n\n\n\n\n\n\n\n\n\n

occurredAt (DateTime!)

When this contribution was made.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who made this contribution.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissalAllowance\n

\n

A team or user who has the ability to dismiss a review on a protected branch.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (ReviewDismissalAllowanceActor)

The actor that can dismiss.

\n\n\n\n\n\n\n\n\n\n\n\n

branchProtectionRule (BranchProtectionRule)

Identifies the branch protection rule associated with the allowed user or team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissalAllowanceConnection\n

\n

The connection type for ReviewDismissalAllowance.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReviewDismissalAllowanceEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ReviewDismissalAllowance])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissalAllowanceEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ReviewDismissalAllowance)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewDismissedEvent\n

\n

Represents areview_dismissedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissalMessage (String)

Identifies the optional message associated with thereview_dismissedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

dismissalMessageHTML (String)

Identifies the optional message associated with the event, rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

previousReviewState (PullRequestReviewState!)

Identifies the previous state of the review with thereview_dismissedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequestCommit (PullRequestCommit)

Identifies the commit which caused the review to become stale.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this review dismissed event.

\n\n\n\n\n\n\n\n\n\n\n\n

review (PullRequestReview)

Identifies the review associated with thereview_dismissedevent.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this review dismissed event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequest\n

\n

A request for a user to review a pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

asCodeOwner (Boolean!)

Whether this request was created for a code owner.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

Identifies the pull request associated with this review request.

\n\n\n\n\n\n\n\n\n\n\n\n

requestedReviewer (RequestedReviewer)

The reviewer that is requested.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestConnection\n

\n

The connection type for ReviewRequest.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([ReviewRequestEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([ReviewRequest])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (ReviewRequest)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestRemovedEvent\n

\n

Represents anreview_request_removedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

requestedReviewer (RequestedReviewer)

Identifies the reviewer whose review request was removed.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewRequestedEvent\n

\n

Represents anreview_requestedevent on a given pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

pullRequest (PullRequest!)

PullRequest referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n

requestedReviewer (RequestedReviewer)

Identifies the reviewer whose review was requested.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ReviewStatusHovercardContext\n

\n

A hovercard context with a message describing the current code review state of the pull\nrequest.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewDecision (PullRequestReviewDecision)

The current status of the pull request with respect to code review.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SavedReply\n

\n

A Saved Reply is text a user can use to reply quickly.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

body (String!)

The body of the saved reply.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The saved reply body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the saved reply.

\n\n\n\n\n\n\n\n\n\n\n\n

user (Actor)

The user that saved this reply.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SavedReplyConnection\n

\n

The connection type for SavedReply.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SavedReplyEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SavedReply])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SavedReplyEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SavedReply)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SearchResultItemConnection\n

\n

A list of results that matched against a search query.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

codeCount (Int!)

The number of pieces of code that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

edges ([SearchResultItemEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

issueCount (Int!)

The number of issues that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SearchResultItem])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryCount (Int!)

The number of repositories that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

userCount (Int!)

The number of users that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n

wikiCount (Int!)

The number of wiki pages that matched the search query.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SearchResultItemEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SearchResultItem)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n

textMatches ([TextMatch])

Text matches on the result found.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisory\n

\n

A GitHub Security Advisory.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cvss (CVSS!)

The CVSS associated with this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

cwes (CWEConnection!)

CWEs associated with this Advisory.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String!)

This is a long plaintext description of the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

ghsaId (String!)

The GitHub Security Advisory ID.

\n\n\n\n\n\n\n\n\n\n\n\n

identifiers ([SecurityAdvisoryIdentifier!]!)

A list of identifiers for this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

notificationsPermalink (URI)

The permalink for the advisory's dependabot alerts page.

\n\n\n\n\n\n\n\n\n\n\n\n

origin (String!)

The organization that originated the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

permalink (URI)

The permalink for the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime!)

When the advisory was published.

\n\n\n\n\n\n\n\n\n\n\n\n

references ([SecurityAdvisoryReference!]!)

A list of references for this advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

severity (SecurityAdvisorySeverity!)

The severity of the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

summary (String!)

A short plaintext summary of the advisory.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

When the advisory was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerabilities (SecurityVulnerabilityConnection!)

Vulnerabilities associated with this Advisory.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

ecosystem (SecurityAdvisoryEcosystem)

\n

An ecosystem to filter vulnerabilities by.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

package (String)

\n

A package name to filter vulnerabilities by.

\n\n
\n\n
\n

severities ([SecurityAdvisorySeverity!])

\n

A list of severities to filter vulnerabilities by.

\n\n
\n\n
\n\n\n

withdrawnAt (DateTime)

When the advisory was withdrawn, if it has been withdrawn.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryConnection\n

\n

The connection type for SecurityAdvisory.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SecurityAdvisoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SecurityAdvisory])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SecurityAdvisory)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryIdentifier\n

\n

A GitHub Security Advisory Identifier.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

type (String!)

The identifier type, e.g. GHSA, CVE.

\n\n\n\n\n\n\n\n\n\n\n\n

value (String!)

The identifier.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryPackage\n

\n

An individual package.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

ecosystem (SecurityAdvisoryEcosystem!)

The ecosystem the package belongs to, e.g. RUBYGEMS, NPM.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The package name.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryPackageVersion\n

\n

An individual package version.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

identifier (String!)

The package name or version.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityAdvisoryReference\n

\n

A GitHub Security Advisory Reference.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n
NameDescription

url (URI!)

A publicly accessible reference.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityVulnerability\n

\n

An individual vulnerability within an Advisory.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

advisory (SecurityAdvisory!)

The Advisory associated with this Vulnerability.

\n\n\n\n\n\n\n\n\n\n\n\n

firstPatchedVersion (SecurityAdvisoryPackageVersion)

The first version containing a fix for the vulnerability.

\n\n\n\n\n\n\n\n\n\n\n\n

package (SecurityAdvisoryPackage!)

A description of the vulnerable package.

\n\n\n\n\n\n\n\n\n\n\n\n

severity (SecurityAdvisorySeverity!)

The severity of the vulnerability within this package.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

When the vulnerability was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

vulnerableVersionRange (String!)

A string that describes the vulnerable package versions.\nThis string follows a basic syntax with a few forms.

\n
    \n
  • = 0.2.0 denotes a single vulnerable version.
    • \n
  • <= 1.0.8 denotes a version range up to and including the specified version
    • \n
  • < 0.1.11 denotes a version range up to, but excluding, the specified version
    • \n
  • >= 4.3.0, < 4.3.5 denotes a version range with a known minimum and maximum version.
    • \n
  • >= 0.0.1 denotes a version range with a known minimum, but no known maximum.
    • \n

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityVulnerabilityConnection\n

\n

The connection type for SecurityVulnerability.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SecurityVulnerabilityEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([SecurityVulnerability])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SecurityVulnerabilityEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (SecurityVulnerability)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SmimeSignature\n

\n

Represents an S/MIME signature on a Commit or Tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String!)

Email used to sign this object.

\n\n\n\n\n\n\n\n\n\n\n\n

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (String!)

ASCII-armored signature header from object.

\n\n\n\n\n\n\n\n\n\n\n\n

signer (User)

GitHub user corresponding to the email signing this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

\n\n\n\n\n\n\n\n\n\n\n\n

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Sponsorship\n

\n

A sponsorship relationship between a sponsor and a maintainer.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

maintainer (User!)

The entity that is being sponsored.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

maintainer is deprecated.

Sponsorship.maintainer will be removed. Use Sponsorship.sponsorable instead. Removal on 2020-04-01 UTC.

\n
\n\n\n\n\n\n\n

privacyLevel (SponsorshipPrivacy!)

The privacy level for this sponsorship.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsor (User)

The user that is sponsoring. Returns null if the sponsorship is private or if sponsor is not a user.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

sponsor is deprecated.

Sponsorship.sponsor will be removed. Use Sponsorship.sponsorEntity instead. Removal on 2020-10-01 UTC.

\n
\n\n\n\n\n\n\n

sponsorEntity (Sponsor)

The user or organization that is sponsoring, if you have permission to view them.

\n\n\n\n\n\n\n\n\n\n\n\n

sponsorable (Sponsorable!)

The entity that is being sponsored.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorshipConnection\n

\n

The connection type for Sponsorship.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SponsorshipEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Sponsorship])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SponsorshipEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Sponsorship)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StargazerConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([StargazerEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StargazerEdge\n

\n

Represents a user that's starred a repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

starredAt (DateTime!)

Identifies when the item was starred.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StarredRepositoryConnection\n

\n

The connection type for Repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([StarredRepositoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

isOverLimit (Boolean!)

Is the list of stars for this user truncated? This is true for users that have many stars.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Repository])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StarredRepositoryEdge\n

\n

Represents a starred repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

starredAt (DateTime!)

Identifies when the item was starred.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Status\n

\n

Represents a commit status.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

combinedContexts (StatusCheckRollupContextConnection!)

A list of status contexts and check runs for this commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

commit (Commit)

The commit this status is attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

context (StatusContext)

Looks up an individual status context by context name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

The context name.

\n\n
\n\n
\n\n\n

contexts ([StatusContext!]!)

The individual status contexts for this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (StatusState!)

The combined commit status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusCheckRollup\n

\n

Represents the rollup for both the check runs and status for a commit.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

commit (Commit)

The commit the status and check runs are attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

contexts (StatusCheckRollupContextConnection!)

A list of status contexts and check runs for this commit.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

state (StatusState!)

The combined status for the commit.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusCheckRollupContextConnection\n

\n

The connection type for StatusCheckRollupContext.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([StatusCheckRollupContextEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([StatusCheckRollupContext])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusCheckRollupContextEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (StatusCheckRollupContext)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n StatusContext\n

\n

Represents an individual commit status context.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

avatarUrl (URI)

The avatar of the OAuth application or the user that created the status.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n

The default value is 40.

\n
\n\n
\n\n\n

commit (Commit)

This commit this status context is attached to.

\n\n\n\n\n\n\n\n\n\n\n\n

context (String!)

The name of this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

creator (Actor)

The actor who created this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description for this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

state (StatusState!)

The state of this status context.

\n\n\n\n\n\n\n\n\n\n\n\n

targetUrl (URI)

The URL for this status context.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Submodule\n

\n

A pointer to a repository at a specific revision embedded inside another repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

branch (String)

The branch of the upstream submodule for tracking updates.

\n\n\n\n\n\n\n\n\n\n\n\n

gitUrl (URI!)

The git URL of the submodule repository.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the submodule in .gitmodules.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String!)

The path in the superproject that this submodule is located in.

\n\n\n\n\n\n\n\n\n\n\n\n

subprojectCommitOid (GitObjectID)

The commit revision of the subproject repository being tracked by the submodule.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SubmoduleConnection\n

\n

The connection type for Submodule.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([SubmoduleEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Submodule])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SubmoduleEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Submodule)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SubscribedEvent\n

\n

Represents asubscribedevent on a given Subscribable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribable (Subscribable!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n SuggestedReviewer\n

\n

A suggestion to review a pull request based on a user's commit history and review comments.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

isAuthor (Boolean!)

Is this suggestion based on past commits?.

\n\n\n\n\n\n\n\n\n\n\n\n

isCommenter (Boolean!)

Is this suggestion based on past review comments?.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewer (User!)

Identifies the user suggested to review the pull request.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Tag\n

\n

Represents a Git tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

The Git tag message.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The Git tag name.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the Git object belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

tagger (GitActor)

Details about the tag author.

\n\n\n\n\n\n\n\n\n\n\n\n

target (GitObject!)

The Git object the tag points to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Team\n

\n

A team of users in an organization.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

ancestors (TeamConnection!)

A list of teams that are ancestors of this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

avatarUrl (URI)

A URL pointing to the team's avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size in pixels of the resulting square image.

\n

The default value is 400.

\n
\n\n
\n\n\n

childTeams (TeamConnection!)

List of child teams belonging to this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

immediateOnly (Boolean)

\n

Whether to list immediate child teams or all descendant child teams.

\n

The default value is true.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamOrder)

\n

Order for connection.

\n\n
\n\n
\n

userLogins ([String!])

\n

User logins to filter by.

\n\n
\n\n
\n\n\n

combinedSlug (String!)

The slug corresponding to the organization and team.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

description (String)

The description of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

discussion (TeamDiscussion)

Find a team discussion by its number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The sequence number of the discussion to find.

\n\n
\n\n
\n\n\n

discussions (TeamDiscussionConnection!)

A list of team discussions.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isPinned (Boolean)

\n

If provided, filters discussions according to whether or not they are pinned.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamDiscussionOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

discussionsResourcePath (URI!)

The HTTP path for team discussions.

\n\n\n\n\n\n\n\n\n\n\n\n

discussionsUrl (URI!)

The HTTP URL for team discussions.

\n\n\n\n\n\n\n\n\n\n\n\n

editTeamResourcePath (URI!)

The HTTP path for editing this team.

\n\n\n\n\n\n\n\n\n\n\n\n

editTeamUrl (URI!)

The HTTP URL for editing this team.

\n\n\n\n\n\n\n\n\n\n\n\n

invitations (OrganizationInvitationConnection)

A list of pending invitations for users to this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

memberStatuses (UserStatusConnection!)

Get the status messages members of this entity have set that are either public or visible only to the organization.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (UserStatusOrder)

\n

Ordering options for user statuses returned from the connection.

\n\n
\n\n
\n\n\n

members (TeamMemberConnection!)

A list of users who are members of this team.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

membership (TeamMembershipType)

\n

Filter by membership type.

\n

The default value is ALL.

\n
\n\n
\n

orderBy (TeamMemberOrder)

\n

Order for the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n

role (TeamMemberRole)

\n

Filter by team member role.

\n\n
\n\n
\n\n\n

membersResourcePath (URI!)

The HTTP path for the team' members.

\n\n\n\n\n\n\n\n\n\n\n\n

membersUrl (URI!)

The HTTP URL for the team' members.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamResourcePath (URI!)

The HTTP path creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

newTeamUrl (URI!)

The HTTP URL creating a new team.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization!)

The organization that owns this team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeam (Team)

The parent team of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

privacy (TeamPrivacy!)

The level of privacy the team has.

\n\n\n\n\n\n\n\n\n\n\n\n

repositories (TeamRepositoryConnection!)

A list of repositories this team has access to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamRepositoryOrder)

\n

Order for the connection.

\n\n
\n\n
\n

query (String)

\n

The search string to look for.

\n\n
\n\n
\n\n\n

repositoriesResourcePath (URI!)

The HTTP path for this team's repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoriesUrl (URI!)

The HTTP URL for this team's repositories.

\n\n\n\n\n\n\n\n\n\n\n\n

resourcePath (URI!)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

reviewRequestDelegationAlgorithm (TeamReviewAssignmentAlgorithm)

What algorithm is used for review assignment for this team.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationAlgorithm is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

reviewRequestDelegationEnabled (Boolean!)

True if review assignment is enabled for this team.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationEnabled is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

reviewRequestDelegationMemberCount (Int)

How many team members are required for review assignment for this team.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationMemberCount is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

reviewRequestDelegationNotifyTeam (Boolean!)

When assigning team members via delegation, whether the entire team should be notified as well.

\n\n\n\n\n
\n

Preview notice

\n

reviewRequestDelegationNotifyTeam is available under the Team review assignments preview. During the preview period, the API may change without notice.

\n
\n\n\n\n\n\n\n\n\n

slug (String!)

The slug corresponding to the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsResourcePath (URI!)

The HTTP path for this team's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

teamsUrl (URI!)

The HTTP URL for this team's teams.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanAdminister (Boolean!)

Team is adminable by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamAddMemberAuditEntry\n

\n

Audit log entry for a team.add_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamAddRepositoryAuditEntry\n

\n

Audit log entry for a team.add_repository event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamChangeParentTeamAuditEntry\n

\n

Audit log entry for a team.change_parent_team event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeam (Team)

The new parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamName (String)

The name of the new parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamNameWas (String)

The name of the former parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamResourcePath (URI)

The HTTP path for the parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamUrl (URI)

The HTTP URL for the parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamWas (Team)

The former parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamWasResourcePath (URI)

The HTTP path for the previous parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

parentTeamWasUrl (URI)

The HTTP URL for the previous parent team.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamConnection\n

\n

The connection type for Team.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Team])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussion\n

\n

A team discussion.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the discussion's team.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String!)

Identifies the discussion body hash.

\n\n\n\n\n\n\n\n\n\n\n\n

comments (TeamDiscussionCommentConnection!)

A list of comments on this discussion.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

fromComment (Int)

\n

When provided, filters the connection such that results begin with the comment with this number.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (TeamDiscussionCommentOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

commentsResourcePath (URI!)

The HTTP path for discussion comments.

\n\n\n\n\n\n\n\n\n\n\n\n

commentsUrl (URI!)

The HTTP URL for discussion comments.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

isPinned (Boolean!)

Whether or not the discussion is pinned.

\n\n\n\n\n\n\n\n\n\n\n\n

isPrivate (Boolean!)

Whether or not the discussion is only visible to team members and org admins.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the discussion within its team.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team!)

The team that defines the context of this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

title (String!)

The title of the discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanPin (Boolean!)

Whether or not the current viewer can pin this discussion.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanSubscribe (Boolean!)

Check if the viewer is able to change their subscription status for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerSubscription (SubscriptionState)

Identifies if the viewer is watching, not watching, or ignoring the subscribable entity.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionComment\n

\n

A comment on a team discussion.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

author (Actor)

The actor who authored the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

authorAssociation (CommentAuthorAssociation!)

Author's association with the comment's team.

\n\n\n\n\n\n\n\n\n\n\n\n

body (String!)

The body as Markdown.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyHTML (HTML!)

The body rendered to HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyText (String!)

The body rendered to text.

\n\n\n\n\n\n\n\n\n\n\n\n

bodyVersion (String!)

The current version of the body content.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

createdViaEmail (Boolean!)

Check if this comment was created via an email reply.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

discussion (TeamDiscussion!)

The discussion this comment is about.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited the comment.

\n\n\n\n\n\n\n\n\n\n\n\n

includesCreatedEdit (Boolean!)

Check if this comment was edited and includes an edit with the creation data.

\n\n\n\n\n\n\n\n\n\n\n\n

lastEditedAt (DateTime)

The moment the editor made the last edit.

\n\n\n\n\n\n\n\n\n\n\n\n

number (Int!)

Identifies the comment number.

\n\n\n\n\n\n\n\n\n\n\n\n

publishedAt (DateTime)

Identifies when the comment was published at.

\n\n\n\n\n\n\n\n\n\n\n\n

reactionGroups ([ReactionGroup!])

A list of reactions grouped by content left on the subject.

\n\n\n\n\n\n\n\n\n\n\n\n

reactions (ReactionConnection!)

A list of Reactions left on the Issue.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

content (ReactionContent)

\n

Allows filtering Reactions by emoji.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ReactionOrder)

\n

Allows specifying the order in which reactions are returned.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

userContentEdits (UserContentEditConnection)

A list of edits to this content.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

viewerCanDelete (Boolean!)

Check if the current viewer can delete this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanReact (Boolean!)

Can user react to this subject.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanUpdate (Boolean!)

Check if the current viewer can update this object.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCannotUpdateReasons ([CommentCannotUpdateReason!]!)

Reasons why the current viewer can not update this comment.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerDidAuthor (Boolean!)

Did the viewer author this comment.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentConnection\n

\n

The connection type for TeamDiscussionComment.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamDiscussionCommentEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([TeamDiscussionComment])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionCommentEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (TeamDiscussionComment)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionConnection\n

\n

The connection type for TeamDiscussion.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamDiscussionEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([TeamDiscussion])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamDiscussionEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (TeamDiscussion)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (Team)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamMemberConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamMemberEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamMemberEdge\n

\n

Represents a user who is a member of a team.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

memberAccessResourcePath (URI!)

The HTTP path to the organization's member access page.

\n\n\n\n\n\n\n\n\n\n\n\n

memberAccessUrl (URI!)

The HTTP URL to the organization's member access page.

\n\n\n\n\n\n\n\n\n\n\n\n

role (TeamMemberRole!)

The role the member has on the team.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRemoveMemberAuditEntry\n

\n

Audit log entry for a team.remove_member event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRemoveRepositoryAuditEntry\n

\n

Audit log entry for a team.remove_repository event.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

action (String!)

The action name.

\n\n\n\n\n\n\n\n\n\n\n\n

actor (AuditEntryActor)

The user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorIp (String)

The IP address of the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLocation (ActorLocation)

A readable representation of the actor's location.

\n\n\n\n\n\n\n\n\n\n\n\n

actorLogin (String)

The username of the user who initiated the action.

\n\n\n\n\n\n\n\n\n\n\n\n

actorResourcePath (URI)

The HTTP path for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

actorUrl (URI)

The HTTP URL for the actor.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (PreciseDateTime!)

The time the action was initiated.

\n\n\n\n\n\n\n\n\n\n\n\n

isLdapMapped (Boolean)

Whether the team was mapped to an LDAP Group.

\n\n\n\n\n\n\n\n\n\n\n\n

operationType (OperationType)

The corresponding operation type for the action.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The Organization associated with the Audit Entry.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationName (String)

The name of the Organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationResourcePath (URI)

The HTTP path for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

organizationUrl (URI)

The HTTP URL for the organization.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository)

The repository associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryName (String)

The name of the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryResourcePath (URI)

The HTTP path for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

repositoryUrl (URI)

The HTTP URL for the repository.

\n\n\n\n\n\n\n\n\n\n\n\n

team (Team)

The team associated with the action.

\n\n\n\n\n\n\n\n\n\n\n\n

teamName (String)

The name of the team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamResourcePath (URI)

The HTTP path for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

teamUrl (URI)

The HTTP URL for this team.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

The user affected by the action.

\n\n\n\n\n\n\n\n\n\n\n\n

userLogin (String)

For actions involving two users, the actor is the initiator and the user is the affected user.

\n\n\n\n\n\n\n\n\n\n\n\n

userResourcePath (URI)

The HTTP path for the user.

\n\n\n\n\n\n\n\n\n\n\n\n

userUrl (URI)

The HTTP URL for the user.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRepositoryConnection\n

\n

The connection type for Repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([TeamRepositoryEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([Repository])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TeamRepositoryEdge\n

\n

Represents a team repository.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

permission (RepositoryPermission!)

The permission level the team has on the repository.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TextMatch\n

\n

A text match within a search result.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

fragment (String!)

The specific text fragment within the property matched on.

\n\n\n\n\n\n\n\n\n\n\n\n

highlights ([TextMatchHighlight!]!)

Highlights within the matched fragment.

\n\n\n\n\n\n\n\n\n\n\n\n

property (String!)

The property matched on.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TextMatchHighlight\n

\n

Represents a single highlight in a search result match.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

beginIndice (Int!)

The indice in the fragment where the matched text begins.

\n\n\n\n\n\n\n\n\n\n\n\n

endIndice (Int!)

The indice in the fragment where the matched text ends.

\n\n\n\n\n\n\n\n\n\n\n\n

text (String!)

The text matched.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Topic\n

\n

A topic aggregates entities that are related to a subject.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

name (String!)

The topic's name.

\n\n\n\n\n\n\n\n\n\n\n\n

relatedTopics ([Topic!]!)

A list of related topics, including aliases of this topic, sorted with the most relevant\nfirst. Returns up to 10 Topics.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

first (Int)

\n

How many topics to return.

\n

The default value is 3.

\n
\n\n
\n\n\n

stargazerCount (Int!)

Returns a count of how many stargazers there are on this object.

\n\n\n\n\n\n\n\n\n\n\n\n

stargazers (StargazerConnection!)

A list of users who have starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n\n\n

viewerHasStarred (Boolean!)

Returns a boolean indicating whether the viewing user has starred this starrable.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TransferredEvent\n

\n

Represents atransferredevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

fromRepository (Repository)

The repository this came from.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n Tree\n

\n

Represents a Git tree.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

abbreviatedOid (String!)

An abbreviated version of the Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

commitResourcePath (URI!)

The HTTP path for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

commitUrl (URI!)

The HTTP URL for this Git object.

\n\n\n\n\n\n\n\n\n\n\n\n

entries ([TreeEntry!])

A list of tree entries.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

The Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the Git object belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n TreeEntry\n

\n

Represents a Git tree entry.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

extension (String)

The extension of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

isGenerated (Boolean!)

Whether or not this tree entry is generated.

\n\n\n\n\n\n\n\n\n\n\n\n

mode (Int!)

Entry file mode.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String!)

Entry file name.

\n\n\n\n\n\n\n\n\n\n\n\n

object (GitObject)

Entry file object.

\n\n\n\n\n\n\n\n\n\n\n\n

oid (GitObjectID!)

Entry file Git object ID.

\n\n\n\n\n\n\n\n\n\n\n\n

path (String)

The full path of the file.

\n\n\n\n\n\n\n\n\n\n\n\n

repository (Repository!)

The Repository the tree entry belongs to.

\n\n\n\n\n\n\n\n\n\n\n\n

submodule (Submodule)

If the TreeEntry is for a directory occupied by a submodule project, this returns the corresponding submodule.

\n\n\n\n\n\n\n\n\n\n\n\n

type (String!)

Entry file type.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnassignedEvent\n

\n

Represents anunassignedevent on any assignable object.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignable (Assignable!)

Identifies the assignable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n

assignee (Assignee)

Identifies the user or mannequin that was unassigned.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User)

Identifies the subject (user) who was unassigned.

\n\n\n\n\n\n\n
\n

Deprecation notice

\n

user is deprecated.

Assignees can now be mannequins. Use the assignee field instead. Removal on 2020-01-01 UTC.

\n
\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnknownSignature\n

\n

Represents an unknown signature on a Commit or Tag.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

email (String!)

Email used to sign this object.

\n\n\n\n\n\n\n\n\n\n\n\n

isValid (Boolean!)

True if the signature is valid and verified by GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

payload (String!)

Payload for GPG signing object. Raw ODB object without the signature header.

\n\n\n\n\n\n\n\n\n\n\n\n

signature (String!)

ASCII-armored signature header from object.

\n\n\n\n\n\n\n\n\n\n\n\n

signer (User)

GitHub user corresponding to the email signing this commit.

\n\n\n\n\n\n\n\n\n\n\n\n

state (GitSignatureState!)

The state of this signature. VALID if signature is valid and verified by\nGitHub, otherwise represents reason why signature is considered invalid.

\n\n\n\n\n\n\n\n\n\n\n\n

wasSignedByGitHub (Boolean!)

True if the signature was made with GitHub's signing key.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnlabeledEvent\n

\n

Represents anunlabeledevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

label (Label!)

Identifies the label associated with theunlabeledevent.

\n\n\n\n\n\n\n\n\n\n\n\n

labelable (Labelable!)

Identifies the Labelable associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnlockedEvent\n

\n

Represents anunlockedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

lockable (Lockable!)

Object that was unlocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnmarkedAsDuplicateEvent\n

\n

Represents anunmarked_as_duplicateevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

canonical (IssueOrPullRequest)

The authoritative issue or pull request which has been duplicated by another.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

duplicate (IssueOrPullRequest)

The issue or pull request which has been marked as a duplicate of another.

\n\n\n\n\n\n\n\n\n\n\n\n

isCrossRepository (Boolean!)

Canonical and duplicate belong to different repositories.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnpinnedEvent\n

\n

Represents anunpinnedevent on a given issue or pull request.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

issue (Issue!)

Identifies the issue associated with the event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UnsubscribedEvent\n

\n

Represents anunsubscribedevent on a given Subscribable.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subscribable (Subscribable!)

Object referenced by event.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n User\n

\n

A user is an individual's account on GitHub that owns repositories and can make new content.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

anyPinnableItems (Boolean!)

Determine if this repository owner has any items that can be pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

type (PinnableItemType)

\n

Filter to only a particular kind of pinnable item.

\n\n
\n\n
\n\n\n

avatarUrl (URI!)

A URL pointing to the user's public avatar.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

size (Int)

\n

The size of the resulting square image.

\n\n
\n\n
\n\n\n

bio (String)

The user's public profile bio.

\n\n\n\n\n\n\n\n\n\n\n\n

bioHTML (HTML!)

The user's public profile bio as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

commitComments (CommitCommentConnection!)

A list of commit comments made by this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

company (String)

The user's public profile company.

\n\n\n\n\n\n\n\n\n\n\n\n

companyHTML (HTML!)

The user's public profile company as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

contributionsCollection (ContributionsCollection!)

The collection of contributions this user has made to different repositories.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

from (DateTime)

\n

Only contributions made at this time or later will be counted. If omitted, defaults to a year ago.

\n\n
\n\n
\n

organizationID (ID)

\n

The ID of the organization used to filter contributions.

\n\n
\n\n
\n

to (DateTime)

\n

Only contributions made before and up to and including this time will be\ncounted. If omitted, defaults to the current time.

\n\n
\n\n
\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

email (String!)

The user's publicly visible profile email.

\n\n\n\n\n\n\n\n\n\n\n\n

followers (FollowerConnection!)

A list of users the given user is followed by.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

following (FollowingConnection!)

A list of users the given user is following.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

gist (Gist)

Find gist by repo name.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

The gist name to find.

\n\n
\n\n
\n\n\n

gistComments (GistCommentConnection!)

A list of gist comments made by this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

gists (GistConnection!)

A list of the Gists the user has created.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (GistOrder)

\n

Ordering options for gists returned from the connection.

\n\n
\n\n
\n

privacy (GistPrivacy)

\n

Filters Gists according to privacy.

\n\n
\n\n
\n\n\n

hovercard (Hovercard!)

The hovercard information for this user in a given context.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

primarySubjectId (ID)

\n

The ID of the subject to get the hovercard in the context of.

\n\n
\n\n
\n\n\n

isBountyHunter (Boolean!)

Whether or not this user is a participant in the GitHub Security Bug Bounty.

\n\n\n\n\n\n\n\n\n\n\n\n

isCampusExpert (Boolean!)

Whether or not this user is a participant in the GitHub Campus Experts Program.

\n\n\n\n\n\n\n\n\n\n\n\n

isDeveloperProgramMember (Boolean!)

Whether or not this user is a GitHub Developer Program member.

\n\n\n\n\n\n\n\n\n\n\n\n

isEmployee (Boolean!)

Whether or not this user is a GitHub employee.

\n\n\n\n\n\n\n\n\n\n\n\n

isGitHubStar (Boolean!)

Whether or not this user is a member of the GitHub Stars Program.

\n\n\n\n\n\n\n\n\n\n\n\n

isHireable (Boolean!)

Whether or not the user has marked themselves as for hire.

\n\n\n\n\n\n\n\n\n\n\n\n

isSiteAdmin (Boolean!)

Whether or not this user is a site administrator.

\n\n\n\n\n\n\n\n\n\n\n\n

isViewer (Boolean!)

Whether or not this user is the viewing user.

\n\n\n\n\n\n\n\n\n\n\n\n

issueComments (IssueCommentConnection!)

A list of issue comments made by this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueCommentOrder)

\n

Ordering options for issue comments returned from the connection.

\n\n
\n\n
\n\n\n

issues (IssueConnection!)

A list of issues associated with this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

filterBy (IssueFilters)

\n

Filtering options for issues returned from the connection.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for issues returned from the connection.

\n\n
\n\n
\n

states ([IssueState!])

\n

A list of states to filter the issues by.

\n\n
\n\n
\n\n\n

itemShowcase (ProfileItemShowcase!)

Showcases a selection of repositories and gists that the profile owner has\neither curated or that have been selected automatically based on popularity.

\n\n\n\n\n\n\n\n\n\n\n\n

location (String)

The user's public profile location.

\n\n\n\n\n\n\n\n\n\n\n\n

login (String!)

The username used to login.

\n\n\n\n\n\n\n\n\n\n\n\n

name (String)

The user's public profile name.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

Find an organization by its login that the user belongs to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

login (String!)

\n

The login of the organization to find.

\n\n
\n\n
\n\n\n

organizationVerifiedDomainEmails ([String!]!)

Verified email addresses that match verified domains for a specified organization the user is a member of.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

login (String!)

\n

The login of the organization to match verified domains from.

\n\n
\n\n
\n\n\n

organizations (OrganizationConnection!)

A list of organizations the user belongs to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pinnableItems (PinnableItemConnection!)

A list of repositories and gists this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinnable items that are returned.

\n\n
\n\n
\n\n\n

pinnedItems (PinnableItemConnection!)

A list of repositories and gists this profile owner has pinned to their profile.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

types ([PinnableItemType!])

\n

Filter the types of pinned items that are returned.

\n\n
\n\n
\n\n\n

pinnedItemsRemaining (Int!)

Returns how many more items this profile owner can pin to their profile.

\n\n\n\n\n\n\n\n\n\n\n\n

project (Project)

Find project by number.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

number (Int!)

\n

The project number to find.

\n\n
\n\n
\n\n\n

projects (ProjectConnection!)

A list of projects under the owner.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (ProjectOrder)

\n

Ordering options for projects returned from the connection.

\n\n
\n\n
\n

search (String)

\n

Query to search projects by, currently only searching by name.

\n\n
\n\n
\n

states ([ProjectState!])

\n

A list of states to filter the projects by.

\n\n
\n\n
\n\n\n

projectsResourcePath (URI!)

The HTTP path listing user's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

projectsUrl (URI!)

The HTTP URL listing user's projects.

\n\n\n\n\n\n\n\n\n\n\n\n

publicKeys (PublicKeyConnection!)

A list of public keys associated with this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n\n\n

pullRequests (PullRequestConnection!)

A list of pull requests associated with this user.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

baseRefName (String)

\n

The base ref name to filter the pull requests by.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

headRefName (String)

\n

The head ref name to filter the pull requests by.

\n\n
\n\n
\n

labels ([String!])

\n

A list of label names to filter the pull requests by.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (IssueOrder)

\n

Ordering options for pull requests returned from the connection.

\n\n
\n\n
\n

states ([PullRequestState!])

\n

A list of states to filter the pull requests by.

\n\n
\n\n
\n\n\n

repositories (RepositoryConnection!)

A list of repositories that the user owns.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Array of viewer's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\ncurrent viewer owns.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isFork (Boolean)

\n

If non-null, filters repositories according to whether they are forks of another repository.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

repositoriesContributedTo (RepositoryConnection!)

A list of repositories that the user recently contributed to.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

contributionTypes ([RepositoryContributionType])

\n

If non-null, include only the specified types of contributions. The\nGitHub.com UI uses [COMMIT, ISSUE, PULL_REQUEST, REPOSITORY].

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includeUserRepositories (Boolean)

\n

If true, include user repositories.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

repository (Repository)

Find Repository.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

name (String!)

\n

Name of Repository to find.

\n\n
\n\n
\n\n\n

resourcePath (URI!)

The HTTP path for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

savedReplies (SavedReplyConnection)

Replies this user has saved.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SavedReplyOrder)

\n

The field to order saved replies by.

\n\n
\n\n
\n\n\n

sponsorshipsAsMaintainer (SponsorshipConnection!)

This object's sponsorships as the maintainer.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

includePrivate (Boolean)

\n

Whether or not to include private sponsorships in the result set.

\n

The default value is false.

\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

sponsorshipsAsSponsor (SponsorshipConnection!)

This object's sponsorships as the sponsor.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (SponsorshipOrder)

\n

Ordering options for sponsorships returned from this connection. If left\nblank, the sponsorships will be ordered based on relevancy to the viewer.

\n\n
\n\n
\n\n\n

starredRepositories (StarredRepositoryConnection!)

Repositories the user has starred.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (StarOrder)

\n

Order for connection.

\n\n
\n\n
\n

ownedByViewer (Boolean)

\n

Filters starred repositories to only return repositories owned by the viewer.

\n\n
\n\n
\n\n\n

status (UserStatus)

The user's description of what they're currently doing.

\n\n\n\n\n\n\n\n\n\n\n\n

suspendedAt (DateTime)

Identifies the date and time when the user was suspended.

\n\n\n\n\n\n\n\n\n\n\n\n

topRepositories (RepositoryConnection!)

Repositories the user has contributed to, ordered by contribution rank, plus repositories the user has created.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder!)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

since (DateTime)

\n

How far back in time to fetch contributed repositories.

\n\n
\n\n
\n\n\n

twitterUsername (String)

The user's Twitter username.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

url (URI!)

The HTTP URL for this user.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanChangePinnedItems (Boolean!)

Can the viewer pin repositories and gists to the profile?.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanCreateProjects (Boolean!)

Can the current viewer create new projects on this owner.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerCanFollow (Boolean!)

Whether or not the viewer is able to follow the user.

\n\n\n\n\n\n\n\n\n\n\n\n

viewerIsFollowing (Boolean!)

Whether or not this user is followed by the viewer.

\n\n\n\n\n\n\n\n\n\n\n\n

watching (RepositoryConnection!)

A list of repositories the given user is watching.

\n\n\n\n\n\n\n\n\n\n\n
\n

Arguments

\n\n
\n

affiliations ([RepositoryAffiliation])

\n

Affiliation options for repositories returned from the connection. If none\nspecified, the results will include repositories for which the current\nviewer is an owner or collaborator, or member.

\n\n
\n\n
\n

after (String)

\n

Returns the elements in the list that come after the specified cursor.

\n\n
\n\n
\n

before (String)

\n

Returns the elements in the list that come before the specified cursor.

\n\n
\n\n
\n

first (Int)

\n

Returns the first n elements from the list.

\n\n
\n\n
\n

isLocked (Boolean)

\n

If non-null, filters repositories according to whether they have been locked.

\n\n
\n\n
\n

last (Int)

\n

Returns the last n elements from the list.

\n\n
\n\n
\n

orderBy (RepositoryOrder)

\n

Ordering options for repositories returned from the connection.

\n\n
\n\n
\n

ownerAffiliations ([RepositoryAffiliation])

\n

Array of owner's affiliation options for repositories returned from the\nconnection. For example, OWNER will include only repositories that the\norganization or user being viewed owns.

\n\n
\n\n
\n

privacy (RepositoryPrivacy)

\n

If non-null, filters repositories according to privacy.

\n\n
\n\n
\n\n\n

websiteUrl (URI)

A URL pointing to the user's public website/blog.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserBlockedEvent\n

\n

Represents auser_blockedevent on a given user.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

actor (Actor)

Identifies the actor who performed the event.

\n\n\n\n\n\n\n\n\n\n\n\n

blockDuration (UserBlockDuration!)

Number of days that the user was blocked for.

\n\n\n\n\n\n\n\n\n\n\n\n

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

subject (User)

The user who was blocked.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserConnection\n

\n

The connection type for User.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([User])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserContentEdit\n

\n

An edit on user content.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

deletedAt (DateTime)

Identifies the date and time when the object was deleted.

\n\n\n\n\n\n\n\n\n\n\n\n

deletedBy (Actor)

The actor who deleted this content.

\n\n\n\n\n\n\n\n\n\n\n\n

diff (String)

A summary of the changes for this edit.

\n\n\n\n\n\n\n\n\n\n\n\n

editedAt (DateTime!)

When this content was edited.

\n\n\n\n\n\n\n\n\n\n\n\n

editor (Actor)

The actor who edited this content.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserContentEditConnection\n

\n

A list of edits to content.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserContentEditEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([UserContentEdit])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserContentEditEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (UserContentEdit)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserEdge\n

\n

Represents a user.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (User)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserEmailMetadata\n

\n

Email attributes from External Identity.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

primary (Boolean)

Boolean to identify primary emails.

\n\n\n\n\n\n\n\n\n\n\n\n

type (String)

Type of email.

\n\n\n\n\n\n\n\n\n\n\n\n

value (String!)

Email id.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserStatus\n

\n

The user's description of what they're currently doing.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

emoji (String)

An emoji summarizing the user's status.

\n\n\n\n\n\n\n\n\n\n\n\n

emojiHTML (HTML)

The status emoji as HTML.

\n\n\n\n\n\n\n\n\n\n\n\n

expiresAt (DateTime)

If set, the status will not be shown after this date.

\n\n\n\n\n\n\n\n\n\n\n\n

id (ID!)

ID of the object.

\n\n\n\n\n\n\n\n\n\n\n\n

indicatesLimitedAvailability (Boolean!)

Whether this status indicates the user is not fully available on GitHub.

\n\n\n\n\n\n\n\n\n\n\n\n

message (String)

A brief message describing what the user is doing.

\n\n\n\n\n\n\n\n\n\n\n\n

organization (Organization)

The organization whose members can see this status. If null, this status is publicly visible.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

user (User!)

The user who has this status.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserStatusConnection\n

\n

The connection type for UserStatus.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

edges ([UserStatusEdge])

A list of edges.

\n\n\n\n\n\n\n\n\n\n\n\n

nodes ([UserStatus])

A list of nodes.

\n\n\n\n\n\n\n\n\n\n\n\n

pageInfo (PageInfo!)

Information to aid in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

totalCount (Int!)

Identifies the total count of items in the connection.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n UserStatusEdge\n

\n

An edge in a connection.

\n
\n\n
\n \n\n \n\n\n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

cursor (String!)

A cursor for use in pagination.

\n\n\n\n\n\n\n\n\n\n\n\n

node (UserStatus)

The item at the end of the edge.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n VerifiableDomain\n

\n

A domain that can be verified for an organization or an enterprise.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

createdAt (DateTime!)

Identifies the date and time when the object was created.

\n\n\n\n\n\n\n\n\n\n\n\n

databaseId (Int)

Identifies the primary key from the database.

\n\n\n\n\n\n\n\n\n\n\n\n

dnsHostName (URI)

The DNS host name that should be used for verification.

\n\n\n\n\n\n\n\n\n\n\n\n

domain (URI!)

The unicode encoded domain.

\n\n\n\n\n\n\n\n\n\n\n\n

hasFoundHostName (Boolean!)

Whether a TXT record for verification with the expected host name was found.

\n\n\n\n\n\n\n\n\n\n\n\n

hasFoundVerificationToken (Boolean!)

Whether a TXT record for verification with the expected verification token was found.

\n\n\n\n\n\n\n\n\n\n\n\n

isRequiredForPolicyEnforcement (Boolean!)

Whether this domain is required to exist for an organization or enterprise policy to be enforced.

\n\n\n\n\n\n\n\n\n\n\n\n

isVerified (Boolean!)

Whether or not the domain is verified.

\n\n\n\n\n\n\n\n\n\n\n\n

owner (VerifiableDomainOwner!)

The owner of the domain.

\n\n\n\n\n\n\n\n\n\n\n\n

punycodeEncodedDomain (URI!)

The punycode encoded domain.

\n\n\n\n\n\n\n\n\n\n\n\n

tokenExpirationTime (DateTime)

The time that the current verification token will expire.

\n\n\n\n\n\n\n\n\n\n\n\n

updatedAt (DateTime!)

Identifies the date and time when the object was last updated.

\n\n\n\n\n\n\n\n\n\n\n\n

verificationToken (String)

The current verification token for the domain.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n\n
\n
\n

\n ViewerHovercardContext\n

\n

A hovercard context with a message describing how the viewer is related.

\n
\n\n
\n \n\n \n\n\n \n

\n \n \n\n \n

Fields

\n \n \n\n\n \n \n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
NameDescription

message (String!)

A string describing this context.

\n\n\n\n\n\n\n\n\n\n\n\n

octicon (String!)

An octicon to accompany this context.

\n\n\n\n\n\n\n\n\n\n\n\n

viewer (User!)

Identifies the user who is related to this context.

\n\n\n\n\n\n\n\n\n\n\n\n
\n\n \n
\n
\n
\n", "miniToc": [ { "contents": "\n ActorLocation\n ", diff --git a/lib/graphql/static/previews.json b/lib/graphql/static/previews.json index 2cc645473ad0..c444768e75d0 100644 --- a/lib/graphql/static/previews.json +++ b/lib/graphql/static/previews.json @@ -114,24 +114,6 @@ "accept_header": "application/vnd.github.corsair-preview+json", "href": "/graphql/overview/schema-previews#create-content-attachments-preview" }, - { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, { "title": "Labels preview", "description": "This preview adds support for adding, updating, creating and deleting labels.", @@ -1181,24 +1163,6 @@ "accept_header": "application/vnd.github.corsair-preview+json", "href": "/graphql/overview/schema-previews#create-content-attachments-preview" }, - { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, { "title": "Labels preview", "description": "This preview adds support for adding, updating, creating and deleting labels.", diff --git a/lib/graphql/static/schema-dotcom.json b/lib/graphql/static/schema-dotcom.json index 6da45fc00639..84652b98d2a7 100644 --- a/lib/graphql/static/schema-dotcom.json +++ b/lib/graphql/static/schema-dotcom.json @@ -1389,6 +1389,40 @@ } ] }, + { + "name": "approveVerifiableDomain", + "kind": "mutations", + "id": "approveverifiabledomain", + "href": "/graphql/reference/mutations#approveverifiabledomain", + "description": "

Approve a verifiable domain for notification delivery.

", + "inputFields": [ + { + "name": "input", + "type": "ApproveVerifiableDomainInput!", + "id": "approveverifiabledomaininput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#approveverifiabledomaininput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "domain", + "type": "VerifiableDomain", + "id": "verifiabledomain", + "kind": "objects", + "href": "/graphql/reference/objects#verifiabledomain", + "description": "

The verifiable domain that was approved.

" + } + ] + }, { "name": "archiveRepository", "kind": "mutations", @@ -3471,25 +3505,6 @@ "id": "pinissue", "href": "/graphql/reference/mutations#pinissue", "description": "

Pin an issue to a repository.

", - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, "inputFields": [ { "name": "input", @@ -4590,25 +4605,6 @@ "id": "unpinissue", "href": "/graphql/reference/mutations#unpinissue", "description": "

Unpin a pinned issue from a repository.

", - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, "inputFields": [ { "name": "input", @@ -20164,6 +20160,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "isPinned", + "description": "

Indicates whether or not this issue is currently pinned to the repository issues list.

", + "type": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "isReadByViewer", "description": "

Is this issue read by the viewer.

", @@ -32374,25 +32378,6 @@ "id": "pinnedissue", "href": "/graphql/reference/objects#pinnedissue", "description": "

A Pinned Issue is a issue pinned to a repository's index page.

", - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, "implements": [ { "name": "Node", @@ -32441,25 +32426,6 @@ "id": "pinnedissueconnection", "href": "/graphql/reference/objects#pinnedissueconnection", "description": "

The connection type for PinnedIssue.

", - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, "fields": [ { "name": "edges", @@ -32501,25 +32467,6 @@ "id": "pinnedissueedge", "href": "/graphql/reference/objects#pinnedissueedge", "description": "

An edge in a connection.

", - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, "fields": [ { "name": "cursor", @@ -38819,6 +38766,14 @@ "kind": "objects", "href": "/graphql/reference/objects#ref" }, + { + "name": "tagCommit", + "description": "

The tag commit for this release.

", + "type": "Commit", + "id": "commit", + "kind": "objects", + "href": "/graphql/reference/objects#commit" + }, { "name": "tagName", "description": "

The name of the release's Git tag.

", @@ -44693,26 +44648,7 @@ "href": "/graphql/reference/scalars#int" } } - ], - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - } + ] }, { "name": "primaryLanguage", @@ -53892,6 +53828,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "isGitHubStar", + "description": "

Whether or not this user is a member of the GitHub Stars Program.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "isHireable", "description": "

Whether or not the user has marked themselves as for hire.

", @@ -55936,6 +55880,14 @@ } ], "fields": [ + { + "name": "createdAt", + "description": "

Identifies the date and time when the object was created.

", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, { "name": "databaseId", "description": "

Identifies the primary key from the database.

", @@ -56016,6 +55968,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#datetime" }, + { + "name": "updatedAt", + "description": "

Identifies the date and time when the object was last updated.

", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, { "name": "verificationToken", "description": "

The current verification token for the domain.

", @@ -62056,6 +62016,10 @@ "href": "/graphql/reference/enums#verifiabledomainorderfield", "description": "

Properties by which verifiable domain connections can be ordered.

", "values": [ + { + "name": "CREATED_AT", + "description": "

Order verifiable domains by their creation date.

" + }, { "name": "DOMAIN", "description": "

Order verifiable domains by the domain name.

" @@ -64196,6 +64160,32 @@ } ] }, + { + "name": "ApproveVerifiableDomainInput", + "kind": "inputObjects", + "id": "approveverifiabledomaininput", + "href": "/graphql/reference/input-objects#approveverifiabledomaininput", + "description": "

Autogenerated input type of ApproveVerifiableDomain.

", + "inputFields": [ + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "id", + "description": "

The ID of the verifiable domain to approve.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + } + ] + }, { "name": "ArchiveRepositoryInput", "kind": "inputObjects", diff --git a/lib/graphql/static/schema-ghae.json b/lib/graphql/static/schema-ghae.json index 8d758e8e31f3..29ce306df531 100644 --- a/lib/graphql/static/schema-ghae.json +++ b/lib/graphql/static/schema-ghae.json @@ -1560,6 +1560,48 @@ } ] }, + { + "name": "createEnterpriseOrganization", + "kind": "mutations", + "id": "createenterpriseorganization", + "href": "/graphql/reference/mutations#createenterpriseorganization", + "description": "

Creates an organization as part of an enterprise account.

", + "inputFields": [ + { + "name": "input", + "type": "CreateEnterpriseOrganizationInput!", + "id": "createenterpriseorganizationinput", + "kind": "input-objects", + "href": "/graphql/reference/input-objects#createenterpriseorganizationinput" + } + ], + "returnFields": [ + { + "name": "clientMutationId", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string", + "description": "

A unique identifier for the client performing the mutation.

" + }, + { + "name": "enterprise", + "type": "Enterprise", + "id": "enterprise", + "kind": "objects", + "href": "/graphql/reference/objects#enterprise", + "description": "

The enterprise that owns the created organization.

" + }, + { + "name": "organization", + "type": "Organization", + "id": "organization", + "kind": "objects", + "href": "/graphql/reference/objects#organization", + "description": "

The organization that was created.

" + } + ] + }, { "name": "createIpAllowListEntry", "kind": "mutations", @@ -2870,25 +2912,6 @@ "id": "pinissue", "href": "/graphql/reference/mutations#pinissue", "description": "

Pin an issue to a repository.

", - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, "inputFields": [ { "name": "input", @@ -3667,25 +3690,6 @@ "id": "unpinissue", "href": "/graphql/reference/mutations#unpinissue", "description": "

Unpin a pinned issue from a repository.

", - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, "inputFields": [ { "name": "input", @@ -18386,6 +18390,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "isPinned", + "description": "

Indicates whether or not this issue is currently pinned to the repository issues list.

", + "type": "Boolean", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "isReadByViewer", "description": "

Is this issue read by the viewer.

", @@ -29112,25 +29124,6 @@ "id": "pinnedissue", "href": "/graphql/reference/objects#pinnedissue", "description": "

A Pinned Issue is a issue pinned to a repository's index page.

", - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, "implements": [ { "name": "Node", @@ -29179,25 +29172,6 @@ "id": "pinnedissueconnection", "href": "/graphql/reference/objects#pinnedissueconnection", "description": "

The connection type for PinnedIssue.

", - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, "fields": [ { "name": "edges", @@ -29239,25 +29213,6 @@ "id": "pinnedissueedge", "href": "/graphql/reference/objects#pinnedissueedge", "description": "

An edge in a connection.

", - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - }, "fields": [ { "name": "cursor", @@ -35557,6 +35512,14 @@ "kind": "objects", "href": "/graphql/reference/objects#ref" }, + { + "name": "tagCommit", + "description": "

The tag commit for this release.

", + "type": "Commit", + "id": "commit", + "kind": "objects", + "href": "/graphql/reference/objects#commit" + }, { "name": "tagName", "description": "

The name of the release's Git tag.

", @@ -41227,26 +41190,7 @@ "href": "/graphql/reference/scalars#int" } } - ], - "isDeprecated": false, - "preview": { - "title": "Pinned issues preview", - "description": "This preview adds support for pinned issues.", - "toggled_by": "elektra-preview", - "toggled_on": [ - "Repository.pinnedIssues", - "PinnedIssue", - "PinnedIssueEdge", - "PinnedIssueConnection", - "Mutation.pinIssue", - "Mutation.unpinIssue" - ], - "owning_teams": [ - "@github/pe-pull-requests" - ], - "accept_header": "application/vnd.github.elektra-preview+json", - "href": "/graphql/overview/schema-previews#pinned-issues-preview" - } + ] }, { "name": "primaryLanguage", @@ -49873,6 +49817,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#boolean" }, + { + "name": "isGitHubStar", + "description": "

Whether or not this user is a member of the GitHub Stars Program.

", + "type": "Boolean!", + "id": "boolean", + "kind": "scalars", + "href": "/graphql/reference/scalars#boolean" + }, { "name": "isHireable", "description": "

Whether or not the user has marked themselves as for hire.

", @@ -51775,6 +51727,14 @@ } ], "fields": [ + { + "name": "createdAt", + "description": "

Identifies the date and time when the object was created.

", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, { "name": "databaseId", "description": "

Identifies the primary key from the database.

", @@ -51855,6 +51815,14 @@ "kind": "scalars", "href": "/graphql/reference/scalars#datetime" }, + { + "name": "updatedAt", + "description": "

Identifies the date and time when the object was last updated.

", + "type": "DateTime!", + "id": "datetime", + "kind": "scalars", + "href": "/graphql/reference/scalars#datetime" + }, { "name": "verificationToken", "description": "

The current verification token for the domain.

", @@ -60577,6 +60545,64 @@ } ] }, + { + "name": "CreateEnterpriseOrganizationInput", + "kind": "inputObjects", + "id": "createenterpriseorganizationinput", + "href": "/graphql/reference/input-objects#createenterpriseorganizationinput", + "description": "

Autogenerated input type of CreateEnterpriseOrganization.

", + "inputFields": [ + { + "name": "adminLogins", + "description": "

The logins for the administrators of the new organization.

", + "type": "[String!]!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "billingEmail", + "description": "

The email used for sending billing receipts.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "clientMutationId", + "description": "

A unique identifier for the client performing the mutation.

", + "type": "String", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "enterpriseId", + "description": "

The ID of the enterprise owning the new organization.

", + "type": "ID!", + "id": "id", + "kind": "scalars", + "href": "/graphql/reference/scalars#id", + "isDeprecated": false + }, + { + "name": "login", + "description": "

The login of the new organization.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + }, + { + "name": "profileName", + "description": "

The profile name of the new organization.

", + "type": "String!", + "id": "string", + "kind": "scalars", + "href": "/graphql/reference/scalars#string" + } + ] + }, { "name": "CreateIpAllowListEntryInput", "kind": "inputObjects", diff --git a/lib/redirects/external-sites.json b/lib/redirects/external-sites.json index 4c8a968a046d..7a38ffa7dad1 100644 --- a/lib/redirects/external-sites.json +++ b/lib/redirects/external-sites.json @@ -14,7 +14,7 @@ "/git-scm": "https://git-scm.com/", "/git-user-manual": "http://schacon.github.com/git/user-manual.html", "/github-status": "https://status.github.com/messages", - "/github-support": "https://support.github.com/contact", + "/github-support": "https://support.github.com", "/multiple-keys": "https://developer.github.com/guides/managing-deploy-keys", "/pro-git": "https://git-scm.com/book", "/submodules": "https://git-scm.com/book/en/Git-Tools-Submodules", diff --git a/lib/redirects/get-old-paths-from-permalink.js b/lib/redirects/get-old-paths-from-permalink.js index 1515d9c5e657..bf7055fd8734 100644 --- a/lib/redirects/get-old-paths-from-permalink.js +++ b/lib/redirects/get-old-paths-from-permalink.js @@ -82,6 +82,10 @@ module.exports = function getOldPathsFromPath (currentPath, languageCode, curren oldPaths.add(oldPath .replace(`/enterprise-server@${latest}`, '/enterprise-server')) + // create old path /enterprise-server@latest from new path /enterprise-server@ + oldPaths.add(oldPath + .replace(`/enterprise-server@${latest}`, '/enterprise-server@latest')) + if (!patterns.adminProduct.test(oldPath)) { // create old path /enterprise//user/foo from new path /enterprise-server@/foo oldPaths.add(currentPath diff --git a/lib/redirects/precompile.js b/lib/redirects/precompile.js index 95291fb3819e..9112bb32f427 100755 --- a/lib/redirects/precompile.js +++ b/lib/redirects/precompile.js @@ -2,19 +2,19 @@ const developerRedirects = require('../redirects/static/developer') const { latest } = require('../../lib/enterprise-server-releases') const latestDevRedirects = {} -// Replace hardcoded 'latest' with real value +// Replace hardcoded 'latest' with real value in the redirected path Object.entries(developerRedirects).forEach(([oldPath, newPath]) => { latestDevRedirects[oldPath] = newPath.replace('enterprise-server@latest', `enterprise-server@${latest}`) }) // This function runs at server warmup and precompiles possible redirect routes. // It outputs them in key-value pairs within a neat Javascript object: { oldPath: newPath } -module.exports = function precompileRedirects (pageList) { +module.exports = async function precompileRedirects (pageList) { const allRedirects = Object.assign({}, latestDevRedirects) // CURRENT PAGES PERMALINKS AND FRONTMATTER // create backwards-compatible old paths for page permalinks and frontmatter redirects - pageList.forEach(page => Object.assign(allRedirects, page.buildRedirects())) + await Promise.all(pageList.map(async (page) => Object.assign(allRedirects, page.buildRedirects()))) return allRedirects } diff --git a/lib/redis-accessor.js b/lib/redis-accessor.js index e5fddb95c2e4..cca44d54ba44 100644 --- a/lib/redis-accessor.js +++ b/lib/redis-accessor.js @@ -26,9 +26,14 @@ class RedisAccessor { ? new Redis(REDIS_URL, { ...redisBaseOptions, db: databaseNumber, - tls: { - // Required for production Heroku Redis - rejectUnauthorized: false + + // Only add this configuration for TLS-enabled REDIS_URL values. + // Otherwise, it breaks for local Redis instances without TLS enabled. + ...REDIS_URL.startsWith('rediss://') && { + tls: { + // Required for production Heroku Redis + rejectUnauthorized: false + } } }) : new InMemoryRedis() diff --git a/lib/render-content/renderContent.js b/lib/render-content/renderContent.js index c4bc7e1d418c..b6a81938768c 100644 --- a/lib/render-content/renderContent.js +++ b/lib/render-content/renderContent.js @@ -66,6 +66,10 @@ module.exports = async function renderContent ( .trim() } + if (options.cheerioObject) { + return cheerio.load(html, { xmlMode: true }) + } + if (options.encodeEntities) html = entities.encode(html) return html.trim() diff --git a/lib/rest/static/decorated/api.github.com.json b/lib/rest/static/decorated/api.github.com.json index d9b43bb1ce6f..e71e5b02e217 100644 --- a/lib/rest/static/decorated/api.github.com.json +++ b/lib/rest/static/decorated/api.github.com.json @@ -3145,14 +3145,17 @@ "properties": { "access_token": { "type": "string", - "description": "

The OAuth access token used to authenticate to the GitHub API.

", + "description": "

Required. The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", "rawType": "string", "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", "childParamsGroups": [] } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -3189,7 +3192,7 @@ "bodyParameters": [ { "type": "string", - "description": "

The OAuth access token used to authenticate to the GitHub API.

", + "description": "

Required. The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", "rawType": "string", @@ -3244,7 +3247,7 @@ "properties": { "access_token": { "type": "string", - "description": "

Required. The OAuth access token used to authenticate to the GitHub API.

", + "description": "

Required. Required. The OAuth access token used to authenticate to the GitHub API.

", "example": "e72e16c7e42f292c6912e7710c838347ae178b4a", "name": "access_token", "in": "body", @@ -3273,7 +3276,7 @@ "childParamsGroups": [] }, "repositories": { - "description": "

The list of repository IDs to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

", + "description": "

The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

", "type": "array of strings", "items": { "type": "string", @@ -3282,11 +3285,11 @@ "name": "repositories", "in": "body", "rawType": "array", - "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", + "rawDescription": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", "childParamsGroups": [] }, "repository_ids": { - "description": "

The list of repository names to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

", + "description": "

The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

", "example": [ 1 ], @@ -3297,7 +3300,7 @@ "name": "repository_ids", "in": "body", "rawType": "array", - "rawDescription": "The list of repository names to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", + "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", "childParamsGroups": [] }, "permissions": { @@ -4104,7 +4107,10 @@ } ] } - } + }, + "required": [ + "access_token" + ] } } } @@ -4154,7 +4160,7 @@ "bodyParameters": [ { "type": "string", - "description": "

Required. The OAuth access token used to authenticate to the GitHub API.

", + "description": "

Required. Required. The OAuth access token used to authenticate to the GitHub API.

", "example": "e72e16c7e42f292c6912e7710c838347ae178b4a", "name": "access_token", "in": "body", @@ -4183,7 +4189,7 @@ "childParamsGroups": [] }, { - "description": "

The list of repository IDs to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

", + "description": "

The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

", "type": "array of strings", "items": { "type": "string", @@ -4192,11 +4198,11 @@ "name": "repositories", "in": "body", "rawType": "array", - "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", + "rawDescription": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", "childParamsGroups": [] }, { - "description": "

The list of repository names to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

", + "description": "

The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

", "example": [ 1 ], @@ -4207,7 +4213,7 @@ "name": "repository_ids", "in": "body", "rawType": "array", - "rawDescription": "The list of repository names to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", + "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", "childParamsGroups": [] }, { @@ -17116,6 +17122,7 @@ "encrypted_value": { "type": "string", "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -17160,7 +17167,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "visibility": "selected", "selected_repository_ids": [ @@ -17201,6 +17208,7 @@ { "type": "string", "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -34652,6 +34660,7 @@ "encrypted_value": { "type": "string", "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -34670,7 +34679,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" } } @@ -34706,6 +34715,7 @@ { "type": "string", "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -52380,86 +52390,6 @@ } ] }, - { - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", - "serverUrl": "https://api.github.com", - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "The name of the environment", - "schema": { - "type": "string" - }, - "descriptionHTML": "

The name of the environment

" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/environments/ENVIRONMENT_NAME", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/environments/ENVIRONMENT_NAME
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('POST /repos/{owner}/{repo}/environments/{environment_name}', {\n owner: 'octocat',\n repo: 'hello-world',\n environment_name: 'environment_name'\n})", - "html": "
await octokit.request('POST /repos/{owner}/{repo}/environments/{environment_name}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  environment_name: 'environment_name'\n})\n
" - } - ], - "summary": "Create an environment", - "description": "Create an environment for a repository. If an environment with the specified name already exists, the existing environment will be returned.\n\nThe created environment will not have any protection rules configured. To configure protection rules for the created environment, see \"[Set protection rules for an environment](#set-protection-rules-for-an-environment)\".\n\nYou must authenticate using an access token with the repo scope to use this endpoint.", - "tags": [ - "repos" - ], - "operationId": "repos/create-an-environment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#create-an-environment" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "repos", - "subcategory": "environments" - }, - "slug": "create-an-environment", - "category": "repos", - "categoryLabel": "Repos", - "subcategory": "environments", - "subcategoryLabel": "Environments", - "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Create an environment for a repository. If an environment with the specified name already exists, the existing environment will be returned.

\n

The created environment will not have any protection rules configured. To configure protection rules for the created environment, see \"Set protection rules for an environment\".

\n

You must authenticate using an access token with the repo scope to use this endpoint.

", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Default response", - "payload": "
{\n  \"id\": 161088068,\n  \"node_id\": \"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\n  \"name\": \"staging\",\n  \"url\": \"https://api.github.com/repos/github/hello-world/environments/staging\",\n  \"html_url\": \"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\n  \"created_at\": \"2020-11-23T22:00:40Z\",\n  \"updated_at\": \"2020-11-23T22:00:40Z\",\n  \"protection_rules\": [],\n  \"deployment_branch_policy\": null\n}\n
" - } - ] - }, { "verb": "put", "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", @@ -52506,21 +52436,22 @@ "html": "
await octokit.request('PUT /repos/{owner}/{repo}/environments/{environment_name}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  environment_name: 'environment_name',\n  wait_timer: 42\n})\n
" } ], - "summary": "Set protection rules for an environment", - "description": "Set protection rules, such as required reviewers, for an environment. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"[Environments](/actions/reference/environments#deployment-branches).\"\n\nYou must authenticate using an access token with the repo scope to use this endpoint.", + "summary": "Create or update an environment", + "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"[Environments](/actions/reference/environments#deployment-branches).\"\n\n**Note:** To create or update secrets for an environment, see \"[Secrets](/rest/reference/actions#secrets).\"\n\nYou must authenticate using an access token with the repo scope to use this endpoint.", "tags": [ "repos" ], - "operationId": "repos/set-environment-protection-rules", + "operationId": "repos/create-or-update-environment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#set-protection-rules-for-an-environment" + "url": "https://docs.github.com/rest/reference/repos#create-or-update-an-environment" }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "wait_timer": { "type": "integer", @@ -52533,8 +52464,9 @@ "childParamsGroups": [] }, "reviewers": { - "type": "array of objects", - "description": "

The people or teams that may jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

", + "type": "array of objects or null", + "nullable": true, + "description": "

The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

", "items": { "type": "object", "properties": { @@ -52567,7 +52499,7 @@ "name": "reviewers", "in": "body", "rawType": "array", - "rawDescription": "The people or teams that may jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "rawDescription": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", "childParamsGroups": [ { "parentName": "reviewers", @@ -52662,7 +52594,8 @@ } ] } - } + }, + "additionalProperties": false } } } @@ -52674,13 +52607,13 @@ "category": "repos", "subcategory": "environments" }, - "slug": "set-protection-rules-for-an-environment", + "slug": "create-or-update-an-environment", "category": "repos", "categoryLabel": "Repos", "subcategory": "environments", "subcategoryLabel": "Environments", "notes": [], - "descriptionHTML": "

Set protection rules, such as required reviewers, for an environment. For more information about environment protection rules, see \"Environments.\"

\n

Note: Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"Environments.\"

\n

You must authenticate using an access token with the repo scope to use this endpoint.

", + "descriptionHTML": "

Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"Environments.\"

\n

Note: Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"Environments.\"

\n

Note: To create or update secrets for an environment, see \"Secrets.\"

\n

You must authenticate using an access token with the repo scope to use this endpoint.

", "responses": [ { "httpStatusCode": "200", @@ -52691,7 +52624,7 @@ { "httpStatusCode": "422", "httpStatusMessage": "Unprocessable Entity", - "description": "Response when protected branches and custom branch policies in deployment branch policy are set to the same value" + "description": "Validation error when the environment name is invalid or when protected branches and custom branch policies in deployment branch policy are set to the same value" } ], "bodyParameters": [ @@ -52706,8 +52639,9 @@ "childParamsGroups": [] }, { - "type": "array of objects", - "description": "

The people or teams that may jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

", + "type": "array of objects or null", + "nullable": true, + "description": "

The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

", "items": { "type": "object", "properties": { @@ -52740,7 +52674,7 @@ "name": "reviewers", "in": "body", "rawType": "array", - "rawDescription": "The people or teams that may jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "rawDescription": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", "childParamsGroups": [ { "parentName": "reviewers", @@ -75398,6 +75332,7 @@ "encrypted_value": { "type": "string", "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -75416,7 +75351,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" } } @@ -75452,6 +75387,7 @@ { "type": "string", "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -76178,13 +76114,13 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \\\n -d '{\"schemas\":[\"schemas\"],\"Operations\":[{}]}'", - "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \\\n  -d '{\"schemas\":[\"schemas\"],\"Operations\":[{}]}'
" + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \\\n -d '{\"schemas\":[\"schemas\"],\"Operations\":[{\"op\":\"op\",\"path\":\"path\",\"value\":\"value\"}]}'", + "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/scim/v2/enterprises/ENTERPRISE/Groups/SCIM_GROUP_ID \\\n  -d '{\"schemas\":[\"schemas\"],\"Operations\":[{\"op\":\"op\",\"path\":\"path\",\"value\":\"value\"}]}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {\n enterprise: 'enterprise',\n scim_group_id: 'scim_group_id',\n schemas: [\n 'schemas'\n ],\n Operations: [\n {}\n ]\n})", - "html": "
await octokit.request('PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {\n  enterprise: 'enterprise',\n  scim_group_id: 'scim_group_id',\n  schemas: [\n    'schemas'\n  ],\n  Operations: [\n    {}\n  ]\n})\n
" + "source": "await octokit.request('PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {\n enterprise: 'enterprise',\n scim_group_id: 'scim_group_id',\n schemas: [\n 'schemas'\n ],\n Operations: [\n {\n op: 'op',\n path: 'path',\n value: 'value'\n }\n ]\n})", + "html": "
await octokit.request('PATCH /scim/v2/enterprises/{enterprise}/Groups/{scim_group_id}', {\n  enterprise: 'enterprise',\n  scim_group_id: 'scim_group_id',\n  schemas: [\n    'schemas'\n  ],\n  Operations: [\n    {\n      op: 'op',\n      path: 'path',\n      value: 'value'\n    }\n  ]\n})\n
" } ], "summary": "Update an attribute for a SCIM enterprise group", @@ -76218,14 +76154,110 @@ "Operations": { "type": "array of objects", "description": "

Required. Array of SCIM operations.

", + "minItems": 1, "items": { - "type": "object" + "type": "object", + "properties": { + "op": { + "type": "string", + "enum": [ + "add", + "Add", + "remove", + "Remove", + "replace", + "Replace" + ], + "name": "op", + "in": "body", + "rawType": "string", + "description": "

Required. undefined

", + "childParamsGroups": [] + }, + "path": { + "type": "string", + "name": "path", + "in": "body", + "rawType": "string", + "description": "

undefined

", + "childParamsGroups": [] + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "array" + } + ], + "name": "value", + "in": "body", + "description": "

undefined

", + "childParamsGroups": [] + } + }, + "required": [ + "op" + ] }, "name": "Operations", "in": "body", "rawType": "array", "rawDescription": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "Operations", + "parentType": "items", + "id": "operations-items", + "params": [ + { + "type": "string", + "enum": [ + "add", + "Add", + "remove", + "Remove", + "replace", + "Replace" + ], + "name": "op", + "in": "body", + "rawType": "string", + "description": "

Required. undefined

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "path", + "in": "body", + "rawType": "string", + "description": "

undefined

", + "childParamsGroups": [] + }, + { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "array" + } + ], + "name": "value", + "in": "body", + "description": "

undefined

", + "childParamsGroups": [] + } + ] + } + ] } }, "required": [ @@ -76290,14 +76322,110 @@ { "type": "array of objects", "description": "

Required. Array of SCIM operations.

", + "minItems": 1, "items": { - "type": "object" + "type": "object", + "properties": { + "op": { + "type": "string", + "enum": [ + "add", + "Add", + "remove", + "Remove", + "replace", + "Replace" + ], + "name": "op", + "in": "body", + "rawType": "string", + "description": "

Required. undefined

", + "childParamsGroups": [] + }, + "path": { + "type": "string", + "name": "path", + "in": "body", + "rawType": "string", + "description": "

undefined

", + "childParamsGroups": [] + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "array" + } + ], + "name": "value", + "in": "body", + "description": "

undefined

", + "childParamsGroups": [] + } + }, + "required": [ + "op" + ] }, "name": "Operations", "in": "body", "rawType": "array", "rawDescription": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", - "childParamsGroups": [] + "childParamsGroups": [ + { + "parentName": "Operations", + "parentType": "items", + "id": "operations-items", + "params": [ + { + "type": "string", + "enum": [ + "add", + "Add", + "remove", + "Remove", + "replace", + "Replace" + ], + "name": "op", + "in": "body", + "rawType": "string", + "description": "

Required. undefined

", + "childParamsGroups": [] + }, + { + "type": "string", + "name": "path", + "in": "body", + "rawType": "string", + "description": "

undefined

", + "childParamsGroups": [] + }, + { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "array" + } + ], + "name": "value", + "in": "body", + "description": "

undefined

", + "childParamsGroups": [] + } + ] + } + ] } ] }, diff --git a/lib/rest/static/decorated/ghes-2.20.json b/lib/rest/static/decorated/ghes-2.20.json index aa9d49440390..f577efb58415 100644 --- a/lib/rest/static/decorated/ghes-2.20.json +++ b/lib/rest/static/decorated/ghes-2.20.json @@ -6316,14 +6316,17 @@ "properties": { "access_token": { "type": "string", - "description": "

The OAuth access token used to authenticate to the GitHub API.

", + "description": "

Required. The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", "rawType": "string", "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", "childParamsGroups": [] } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -6360,7 +6363,7 @@ "bodyParameters": [ { "type": "string", - "description": "

The OAuth access token used to authenticate to the GitHub API.

", + "description": "

Required. The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", "rawType": "string", diff --git a/lib/rest/static/decorated/ghes-2.21.json b/lib/rest/static/decorated/ghes-2.21.json index 28d3a0248696..3c95181390a7 100644 --- a/lib/rest/static/decorated/ghes-2.21.json +++ b/lib/rest/static/decorated/ghes-2.21.json @@ -6310,14 +6310,17 @@ "properties": { "access_token": { "type": "string", - "description": "

The OAuth access token used to authenticate to the GitHub API.

", + "description": "

Required. The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", "rawType": "string", "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", "childParamsGroups": [] } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -6354,7 +6357,7 @@ "bodyParameters": [ { "type": "string", - "description": "

The OAuth access token used to authenticate to the GitHub API.

", + "description": "

Required. The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", "rawType": "string", diff --git a/lib/rest/static/decorated/ghes-2.22.json b/lib/rest/static/decorated/ghes-2.22.json index 191b8a41d7b4..23c6a9441334 100644 --- a/lib/rest/static/decorated/ghes-2.22.json +++ b/lib/rest/static/decorated/ghes-2.22.json @@ -6390,14 +6390,17 @@ "properties": { "access_token": { "type": "string", - "description": "

The OAuth access token used to authenticate to the GitHub API.

", + "description": "

Required. The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", "rawType": "string", "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", "childParamsGroups": [] } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -6434,7 +6437,7 @@ "bodyParameters": [ { "type": "string", - "description": "

The OAuth access token used to authenticate to the GitHub API.

", + "description": "

Required. The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", "rawType": "string", @@ -16259,6 +16262,7 @@ "encrypted_value": { "type": "string", "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -16303,7 +16307,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "visibility": "selected", "selected_repository_ids": [ @@ -16344,6 +16348,7 @@ { "type": "string", "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -29639,6 +29644,7 @@ "encrypted_value": { "type": "string", "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -29657,7 +29663,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" } } @@ -29693,6 +29699,7 @@ { "type": "string", "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", diff --git a/lib/rest/static/decorated/ghes-3.0.json b/lib/rest/static/decorated/ghes-3.0.json index 6d098ff7bea1..1bf6c63efcc8 100644 --- a/lib/rest/static/decorated/ghes-3.0.json +++ b/lib/rest/static/decorated/ghes-3.0.json @@ -6592,14 +6592,17 @@ "properties": { "access_token": { "type": "string", - "description": "

The OAuth access token used to authenticate to the GitHub API.

", + "description": "

Required. The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", "rawType": "string", "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", "childParamsGroups": [] } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -6636,7 +6639,7 @@ "bodyParameters": [ { "type": "string", - "description": "

The OAuth access token used to authenticate to the GitHub API.

", + "description": "

Required. The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", "rawType": "string", @@ -6691,7 +6694,7 @@ "properties": { "access_token": { "type": "string", - "description": "

Required. The OAuth access token used to authenticate to the GitHub API.

", + "description": "

Required. Required. The OAuth access token used to authenticate to the GitHub API.

", "example": "e72e16c7e42f292c6912e7710c838347ae178b4a", "name": "access_token", "in": "body", @@ -6720,7 +6723,7 @@ "childParamsGroups": [] }, "repositories": { - "description": "

The list of repository IDs to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

", + "description": "

The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

", "type": "array of strings", "items": { "type": "string", @@ -6729,11 +6732,11 @@ "name": "repositories", "in": "body", "rawType": "array", - "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", + "rawDescription": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", "childParamsGroups": [] }, "repository_ids": { - "description": "

The list of repository names to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

", + "description": "

The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

", "example": [ 1 ], @@ -6744,7 +6747,7 @@ "name": "repository_ids", "in": "body", "rawType": "array", - "rawDescription": "The list of repository names to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", + "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", "childParamsGroups": [] }, "permissions": { @@ -7551,7 +7554,10 @@ } ] } - } + }, + "required": [ + "access_token" + ] } } } @@ -7601,7 +7607,7 @@ "bodyParameters": [ { "type": "string", - "description": "

Required. The OAuth access token used to authenticate to the GitHub API.

", + "description": "

Required. Required. The OAuth access token used to authenticate to the GitHub API.

", "example": "e72e16c7e42f292c6912e7710c838347ae178b4a", "name": "access_token", "in": "body", @@ -7630,7 +7636,7 @@ "childParamsGroups": [] }, { - "description": "

The list of repository IDs to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

", + "description": "

The list of repository names to scope the user-to-server access token to. repositories may not be specified if repository_ids is specified.

", "type": "array of strings", "items": { "type": "string", @@ -7639,11 +7645,11 @@ "name": "repositories", "in": "body", "rawType": "array", - "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", + "rawDescription": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", "childParamsGroups": [] }, { - "description": "

The list of repository names to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

", + "description": "

The list of repository IDs to scope the user-to-server access token to. repository_ids may not be specified if repositories is specified.

", "example": [ 1 ], @@ -7654,7 +7660,7 @@ "name": "repository_ids", "in": "body", "rawType": "array", - "rawDescription": "The list of repository names to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", + "rawDescription": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", "childParamsGroups": [] }, { @@ -19946,6 +19952,7 @@ "encrypted_value": { "type": "string", "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -19990,7 +19997,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "visibility": "selected", "selected_repository_ids": [ @@ -20031,6 +20038,7 @@ { "type": "string", "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -33979,6 +33987,7 @@ "encrypted_value": { "type": "string", "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", @@ -33997,7 +34006,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" } } @@ -34033,6 +34042,7 @@ { "type": "string", "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", "name": "encrypted_value", "in": "body", "rawType": "string", diff --git a/lib/rest/static/decorated/github.ae.json b/lib/rest/static/decorated/github.ae.json index febd2dd11a1d..714b4662e63a 100644 --- a/lib/rest/static/decorated/github.ae.json +++ b/lib/rest/static/decorated/github.ae.json @@ -5203,14 +5203,17 @@ "properties": { "access_token": { "type": "string", - "description": "

The OAuth access token used to authenticate to the GitHub API.

", + "description": "

Required. The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", "rawType": "string", "rawDescription": "The OAuth access token used to authenticate to the GitHub API.", "childParamsGroups": [] } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -5247,7 +5250,7 @@ "bodyParameters": [ { "type": "string", - "description": "

The OAuth access token used to authenticate to the GitHub API.

", + "description": "

Required. The OAuth access token used to authenticate to the GitHub API.

", "name": "access_token", "in": "body", "rawType": "string", @@ -6495,449 +6498,216 @@ }, { "verb": "get", - "requestPath": "/events", + "requestPath": "/enterprises/{enterprise}/actions/permissions", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - }, - "descriptionHTML": "

Results per page (max 100).

" - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "string" }, - "descriptionHTML": "

Page number of the results to fetch.

" + "descriptionHTML": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/events", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/events
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/permissions", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/permissions
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /events')", - "html": "
await octokit.request('GET /events')\n
" + "source": "await octokit.request('GET /enterprises/{enterprise}/actions/permissions', {\n enterprise: 'enterprise'\n})", + "html": "
await octokit.request('GET /enterprises/{enterprise}/actions/permissions', {\n  enterprise: 'enterprise'\n})\n
" } ], - "summary": "List public events", - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "summary": "Get GitHub Actions permissions for an enterprise", + "description": "Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-github-actions-permissions-enterprise", "tags": [ - "activity" - ], - "operationId": "activity/list-public-events", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#list-public-events" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "activity", - "subcategory": "events" - }, - "slug": "list-public-events", - "category": "activity", - "categoryLabel": "Activity", - "subcategory": "events", - "subcategoryLabel": "Events", - "notes": [], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" - } - ], - "bodyParameters": [], - "descriptionHTML": "

We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.

" - }, - { - "verb": "get", - "requestPath": "/feeds", - "serverUrl": "https://api.github.com", - "parameters": [], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/feeds", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/feeds
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('GET /feeds')", - "html": "
await octokit.request('GET /feeds')\n
" - } - ], - "summary": "Get feeds", - "description": "GitHub AE provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub AE global public timeline\n* **User**: The public timeline for any user, using [URI template](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#hypermedia)\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub AE.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", - "tags": [ - "activity" + "enterprise-admin" ], - "operationId": "activity/get-feeds", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#get-feeds" + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-github-actions-permissions-for-an-enterprise" }, "x-github": { + "enabledForGitHubApps": false, "githubCloudOnly": false, - "enabledForGitHubApps": true, "previews": [], - "category": "activity", - "subcategory": "feeds" + "category": "enterprise-admin", + "subcategory": "actions" }, - "slug": "get-feeds", - "category": "activity", - "categoryLabel": "Activity", - "subcategory": "feeds", - "subcategoryLabel": "Feeds", + "slug": "get-github-actions-permissions-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", "notes": [], "bodyParameters": [], - "descriptionHTML": "

GitHub AE provides several timeline resources in Atom format. The Feeds API lists all the feeds available to the authenticated user:

\n
    \n
  • Timeline: The GitHub AE global public timeline
    • \n
  • User: The public timeline for any user, using URI template
    • \n
  • Current user public: The public timeline for the authenticated user
    • \n
  • Current user: The private timeline for the authenticated user
    • \n
  • Current user actor: The private timeline for activity created by the authenticated user
    • \n
  • Current user organizations: The private timeline for the organizations the authenticated user is a member of.
    • \n
  • Security advisories: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub AE.
    • \n
\n

Note: Private feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.

", + "descriptionHTML": "

Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.

\n

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"timeline_url\": \"https://github.com/timeline\",\n  \"user_url\": \"https://github.com/{user}\",\n  \"current_user_public_url\": \"https://github.com/octocat\",\n  \"current_user_url\": \"https://github.com/octocat.private?token=abc123\",\n  \"current_user_actor_url\": \"https://github.com/octocat.private.actor?token=abc123\",\n  \"current_user_organization_url\": \"\",\n  \"current_user_organization_urls\": [\n    \"https://github.com/organizations/github/octocat.private.atom?token=abc123\"\n  ],\n  \"security_advisories_url\": \"https://github.com/security-advisories\",\n  \"_links\": {\n    \"timeline\": {\n      \"href\": \"https://github.com/timeline\",\n      \"type\": \"application/atom+xml\"\n    },\n    \"user\": {\n      \"href\": \"https://github.com/{user}\",\n      \"type\": \"application/atom+xml\"\n    },\n    \"current_user_public\": {\n      \"href\": \"https://github.com/octocat\",\n      \"type\": \"application/atom+xml\"\n    },\n    \"current_user\": {\n      \"href\": \"https://github.com/octocat.private?token=abc123\",\n      \"type\": \"application/atom+xml\"\n    },\n    \"current_user_actor\": {\n      \"href\": \"https://github.com/octocat.private.actor?token=abc123\",\n      \"type\": \"application/atom+xml\"\n    },\n    \"current_user_organization\": {\n      \"href\": \"\",\n      \"type\": \"\"\n    },\n    \"current_user_organizations\": [\n      {\n        \"href\": \"https://github.com/organizations/github/octocat.private.atom?token=abc123\",\n        \"type\": \"application/atom+xml\"\n      }\n    ],\n    \"security_advisories\": {\n      \"href\": \"https://github.com/security-advisories\",\n      \"type\": \"application/atom+xml\"\n    }\n  }\n}\n
" + "payload": "
{\n  \"enabled_organizations\": \"all\",\n  \"allowed_actions\": \"selected\",\n  \"selected_actions_url\": \"https://api.github.com/enterprises/2/actions/permissions/selected-actions\"\n}\n
" } ] }, { - "verb": "get", - "requestPath": "/gists", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/permissions", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - }, - "descriptionHTML": "

Results per page (max 100).

" - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - }, - "descriptionHTML": "

Page number of the results to fetch.

" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('GET /gists')", - "html": "
await octokit.request('GET /gists')\n
" + "descriptionHTML": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

" } ], - "summary": "List gists for the authenticated user", - "description": "Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:", - "tags": [ - "gists" - ], - "operationId": "gists/list", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#list-gists-for-the-authenticated-user" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "previews": [], - "category": "gists", - "subcategory": null - }, - "slug": "list-gists-for-the-authenticated-user", - "category": "gists", - "categoryLabel": "Gists", - "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:

", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Default response", - "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n    \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n    \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n    \"id\": \"aa5a315d61ae9438b18d\",\n    \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n    \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n    \"files\": {\n      \"hello_world.rb\": {\n        \"filename\": \"hello_world.rb\",\n        \"type\": \"application/x-ruby\",\n        \"language\": \"Ruby\",\n        \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n        \"size\": 167\n      }\n    },\n    \"public\": true,\n    \"created_at\": \"2010-04-14T02:15:15Z\",\n    \"updated_at\": \"2011-06-20T11:34:15Z\",\n    \"description\": \"Hello World Examples\",\n    \"comments\": 0,\n    \"user\": null,\n    \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"truncated\": false\n  }\n]\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - } - ] - }, - { - "verb": "post", - "requestPath": "/gists", - "serverUrl": "https://api.github.com", - "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists \\\n -d '{\"files\":{}}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists \\\n  -d '{\"files\":{}}'
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/permissions \\\n -d '{\"enabled_organizations\":\"enabled_organizations\"}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/permissions \\\n  -d '{\"enabled_organizations\":\"enabled_organizations\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /gists', {\n files: {}\n})", - "html": "
await octokit.request('POST /gists', {\n  files: {}\n})\n
" + "source": "await octokit.request('PUT /enterprises/{enterprise}/actions/permissions', {\n enterprise: 'enterprise',\n enabled_organizations: 'enabled_organizations'\n})", + "html": "
await octokit.request('PUT /enterprises/{enterprise}/actions/permissions', {\n  enterprise: 'enterprise',\n  enabled_organizations: 'enabled_organizations'\n})\n
" } ], - "summary": "Create a gist", - "description": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", - "operationId": "gists/create", + "summary": "Set GitHub Actions permissions for an enterprise", + "description": "Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-github-actions-permissions-enterprise", "tags": [ - "gists" + "enterprise-admin" ], "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#create-a-gist" + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise" }, "requestBody": { "content": { "application/json": { "schema": { + "type": "object", "properties": { - "description": { - "description": "

Description of the gist

", - "example": "Example Ruby script", + "enabled_organizations": { "type": "string", - "name": "description", + "description": "

Required. The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: all, none, or selected.

", + "enum": [ + "all", + "none", + "selected" + ], + "name": "enabled_organizations", "in": "body", "rawType": "string", - "rawDescription": "Description of the gist", - "childParamsGroups": [] - }, - "files": { - "description": "

Required. Names and content for the files that make up the gist

", - "example": { - "hello.rb": { - "content": "puts \"Hello, World!\"" - } - }, - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "content": { - "description": "Content of the file", - "readOnly": false, - "type": "string" - } - }, - "required": [ - "content" - ] - }, - "name": "files", - "in": "body", - "rawType": "object", - "rawDescription": "Names and content for the files that make up the gist", + "rawDescription": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", "childParamsGroups": [] }, - "public": { - "oneOf": [ - { - "description": "Flag indicating whether the gist is public", - "example": true, - "type": "boolean", - "default": false - }, - { - "type": "string", - "example": "true", - "default": "false", - "enum": [ - "true", - "false" - ] - } + "allowed_actions": { + "type": "string", + "description": "

The permissions policy that controls the actions that are allowed to run. Can be one of: all, local_only, or selected.

", + "enum": [ + "all", + "local_only", + "selected" ], - "name": "public", + "name": "allowed_actions", "in": "body", - "description": "

undefined

", + "rawType": "string", + "rawDescription": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", "childParamsGroups": [] } }, "required": [ - "files" - ], - "type": "object" + "enabled_organizations" + ] + }, + "example": { + "enabled_organizations": "all", + "allowed_actions": "selected" } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": false, + "githubCloudOnly": false, "previews": [], - "category": "gists", - "subcategory": null + "category": "enterprise-admin", + "subcategory": "actions" }, - "slug": "create-a-gist", - "category": "gists", - "categoryLabel": "Gists", + "slug": "set-github-actions-permissions-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", "notes": [], - "descriptionHTML": "

Allows you to add a new gist with one or more files.

\n

Note: Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.

", "responses": [ { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Default response", - "payload": "
{\n  \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n  \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n  \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n  \"id\": \"aa5a315d61ae9438b18d\",\n  \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n  \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n  \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n  \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n  \"created_at\": \"2010-04-14T02:15:15Z\",\n  \"updated_at\": \"2011-06-20T11:34:15Z\",\n  \"description\": \"Hello World Examples\",\n  \"comments\": 0,\n  \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" } ], + "descriptionHTML": "

Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.

\n

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

", "bodyParameters": [ { - "description": "

Description of the gist

", - "example": "Example Ruby script", "type": "string", - "name": "description", + "description": "

Required. The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: all, none, or selected.

", + "enum": [ + "all", + "none", + "selected" + ], + "name": "enabled_organizations", "in": "body", "rawType": "string", - "rawDescription": "Description of the gist", + "rawDescription": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", "childParamsGroups": [] }, { - "description": "

Required. Names and content for the files that make up the gist

", - "example": { - "hello.rb": { - "content": "puts \"Hello, World!\"" - } - }, - "type": "object", - "additionalProperties": { - "type": "object", - "properties": { - "content": { - "description": "Content of the file", - "readOnly": false, - "type": "string" - } - }, - "required": [ - "content" - ] - }, - "name": "files", - "in": "body", - "rawType": "object", - "rawDescription": "Names and content for the files that make up the gist", - "childParamsGroups": [] - }, - { - "oneOf": [ - { - "description": "Flag indicating whether the gist is public", - "example": true, - "type": "boolean", - "default": false - }, - { - "type": "string", - "example": "true", - "default": "false", - "enum": [ - "true", - "false" - ] - } + "type": "string", + "description": "

The permissions policy that controls the actions that are allowed to run. Can be one of: all, local_only, or selected.

", + "enum": [ + "all", + "local_only", + "selected" ], - "name": "public", + "name": "allowed_actions", "in": "body", - "description": "

undefined

", + "rawType": "string", + "rawDescription": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", "childParamsGroups": [] } ] }, { "verb": "get", - "requestPath": "/gists/public", + "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + "descriptionHTML": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

" }, { "name": "per_page", @@ -6963,697 +6733,766 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/public", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/public
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/permissions/organizations", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/permissions/organizations
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /gists/public')", - "html": "
await octokit.request('GET /gists/public')\n
" + "source": "await octokit.request('GET /enterprises/{enterprise}/actions/permissions/organizations', {\n enterprise: 'enterprise'\n})", + "html": "
await octokit.request('GET /enterprises/{enterprise}/actions/permissions/organizations', {\n  enterprise: 'enterprise'\n})\n
" } ], - "summary": "List public gists", - "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.", + "summary": "List selected organizations enabled for GitHub Actions in an enterprise", + "description": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise", "tags": [ - "gists" + "enterprise-admin" ], - "operationId": "gists/list-public", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#list-public-gists" + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise" }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": false, + "githubCloudOnly": false, "previews": [], - "category": "gists", - "subcategory": null + "category": "enterprise-admin", + "subcategory": "actions" }, - "slug": "list-public-gists", - "category": "gists", - "categoryLabel": "Gists", + "slug": "list-selected-organizations-enabled-for-github-actions-in-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", "notes": [], "bodyParameters": [], - "descriptionHTML": "

List public gists sorted by most recently updated to least recently updated.

\n

Note: With pagination, you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.

", + "descriptionHTML": "

Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n    \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n    \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n    \"id\": \"aa5a315d61ae9438b18d\",\n    \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n    \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n    \"files\": {\n      \"hello_world.rb\": {\n        \"filename\": \"hello_world.rb\",\n        \"type\": \"application/x-ruby\",\n        \"language\": \"Ruby\",\n        \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n        \"size\": 167\n      }\n    },\n    \"public\": true,\n    \"created_at\": \"2010-04-14T02:15:15Z\",\n    \"updated_at\": \"2011-06-20T11:34:15Z\",\n    \"description\": \"Hello World Examples\",\n    \"comments\": 0,\n    \"user\": null,\n    \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"truncated\": false\n  }\n]\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "payload": "
{\n  \"total_count\": 1,\n  \"organizations\": [\n    {\n      \"login\": \"octocat\",\n      \"id\": 161335,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"url\": \"https://api.github.com/orgs/octo-org\",\n      \"repos_url\": \"https://api.github.com/orgs/octo-org/repos\",\n      \"events_url\": \"https://api.github.com/orgs/octo-org/events\",\n      \"hooks_url\": \"https://api.github.com/orgs/octo-org/hooks\",\n      \"issues_url\": \"https://api.github.com/orgs/octo-org/issues\",\n      \"members_url\": \"https://api.github.com/orgs/octo-org/members{/member}\",\n      \"public_members_url\": \"https://api.github.com/orgs/octo-org/public_members{/member}\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"description\": \"A great organization\"\n    }\n  ]\n}\n
" } ] }, { - "verb": "get", - "requestPath": "/gists/starred", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + "descriptionHTML": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/permissions/organizations \\\n -d '{\"selected_organization_ids\":[42]}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/permissions/organizations \\\n  -d '{\"selected_organization_ids\":[42]}'
" }, { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", - "schema": { + "lang": "JavaScript", + "source": "await octokit.request('PUT /enterprises/{enterprise}/actions/permissions/organizations', {\n enterprise: 'enterprise',\n selected_organization_ids: [\n 42\n ]\n})", + "html": "
await octokit.request('PUT /enterprises/{enterprise}/actions/permissions/organizations', {\n  enterprise: 'enterprise',\n  selected_organization_ids: [\n    42\n  ]\n})\n
" + } + ], + "summary": "Set selected organizations enabled for GitHub Actions in an enterprise", + "description": "Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_organization_ids": { + "description": "

Required. List of organization IDs to enable for GitHub Actions.

", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the organization." + }, + "name": "selected_organization_ids", + "in": "body", + "rawType": "array", + "rawDescription": "List of organization IDs to enable for GitHub Actions.", + "childParamsGroups": [] + } + }, + "required": [ + "selected_organization_ids" + ] + }, + "example": { + "selected_organization_ids": [ + 32, + 91 + ] + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "set-selected-organizations-enabled-for-github-actions-in-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "descriptionHTML": "

Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

", + "bodyParameters": [ + { + "description": "

Required. List of organization IDs to enable for GitHub Actions.

", + "type": "array of integers", + "items": { "type": "integer", - "default": 30 + "description": "Unique identifier of the organization." }, - "descriptionHTML": "

Results per page (max 100).

" + "name": "selected_organization_ids", + "in": "body", + "rawType": "array", + "rawDescription": "List of organization IDs to enable for GitHub Actions.", + "childParamsGroups": [] + } + ] + }, + { + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

" }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", + "name": "org_id", + "description": "Unique identifier of an organization.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" }, - "descriptionHTML": "

Page number of the results to fetch.

" + "descriptionHTML": "

Unique identifier of an organization.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/starred", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/starred
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/permissions/organizations/42", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/permissions/organizations/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /gists/starred')", - "html": "
await octokit.request('GET /gists/starred')\n
" + "source": "await octokit.request('PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}', {\n enterprise: 'enterprise',\n org_id: 42\n})", + "html": "
await octokit.request('PUT /enterprises/{enterprise}/actions/permissions/organizations/{org_id}', {\n  enterprise: 'enterprise',\n  org_id: 42\n})\n
" } ], - "summary": "List starred gists", - "description": "List the authenticated user's starred gists:", + "summary": "Enable a selected organization for GitHub Actions in an enterprise", + "description": "Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/enable-selected-organization-github-actions-enterprise", "tags": [ - "gists" + "enterprise-admin" ], - "operationId": "gists/list-starred", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#list-starred-gists" + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise" }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": false, + "githubCloudOnly": false, "previews": [], - "category": "gists", - "subcategory": null + "category": "enterprise-admin", + "subcategory": "actions" }, - "slug": "list-starred-gists", - "category": "gists", - "categoryLabel": "Gists", + "slug": "enable-a-selected-organization-for-github-actions-in-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

List the authenticated user's starred gists:

", "responses": [ { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Default response", - "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n    \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n    \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n    \"id\": \"aa5a315d61ae9438b18d\",\n    \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n    \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n    \"files\": {\n      \"hello_world.rb\": {\n        \"filename\": \"hello_world.rb\",\n        \"type\": \"application/x-ruby\",\n        \"language\": \"Ruby\",\n        \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n        \"size\": 167\n      }\n    },\n    \"public\": true,\n    \"created_at\": \"2010-04-14T02:15:15Z\",\n    \"updated_at\": \"2011-06-20T11:34:15Z\",\n    \"description\": \"Hello World Examples\",\n    \"comments\": 0,\n    \"user\": null,\n    \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"truncated\": false\n  }\n]\n
" - }, + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

" + }, + { + "verb": "delete", + "requestPath": "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}", + "serverUrl": "https://api.github.com", + "parameters": [ { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

" }, { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" + "name": "org_id", + "description": "Unique identifier of an organization.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

Unique identifier of an organization.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/permissions/organizations/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/permissions/organizations/42
" }, { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" + "lang": "JavaScript", + "source": "await octokit.request('DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}', {\n enterprise: 'enterprise',\n org_id: 42\n})", + "html": "
await octokit.request('DELETE /enterprises/{enterprise}/actions/permissions/organizations/{org_id}', {\n  enterprise: 'enterprise',\n  org_id: 42\n})\n
" } - ] + ], + "summary": "Disable a selected organization for GitHub Actions in an enterprise", + "description": "Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/disable-selected-organization-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise" + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [], + "category": "enterprise-admin", + "subcategory": "actions" + }, + "slug": "disable-a-selected-organization-for-github-actions-in-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for enabled_organizations must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

" }, { "verb": "get", - "requestPath": "/gists/{gist_id}", + "requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "gist_id", - "description": "gist_id parameter", + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

gist_id parameter

" + "descriptionHTML": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/permissions/selected-actions", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/permissions/selected-actions
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /gists/{gist_id}', {\n gist_id: 'gist_id'\n})", - "html": "
await octokit.request('GET /gists/{gist_id}', {\n  gist_id: 'gist_id'\n})\n
" + "source": "await octokit.request('GET /enterprises/{enterprise}/actions/permissions/selected-actions', {\n enterprise: 'enterprise'\n})", + "html": "
await octokit.request('GET /enterprises/{enterprise}/actions/permissions/selected-actions', {\n  enterprise: 'enterprise'\n})\n
" } ], - "summary": "Get a gist", - "description": "", + "summary": "Get allowed actions for an enterprise", + "description": "Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-allowed-actions-enterprise", "tags": [ - "gists" + "enterprise-admin" ], - "operationId": "gists/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#get-a-gist" + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-allowed-actions-for-an-enterprise" }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": false, + "githubCloudOnly": false, "previews": [], - "category": "gists", - "subcategory": null + "category": "enterprise-admin", + "subcategory": "actions" }, - "slug": "get-a-gist", - "category": "gists", - "categoryLabel": "Gists", + "slug": "get-allowed-actions-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", "notes": [], "bodyParameters": [], - "descriptionHTML": "", + "descriptionHTML": "

Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n  \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n  \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n  \"id\": \"aa5a315d61ae9438b18d\",\n  \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n  \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n  \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n  \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n  \"created_at\": \"2010-04-14T02:15:15Z\",\n  \"updated_at\": \"2011-06-20T11:34:15Z\",\n  \"description\": \"Hello World Examples\",\n  \"comments\": 0,\n  \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden gist" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "payload": "
{\n  \"github_owned_allowed\": true,\n  \"verified_allowed\": false,\n  \"patterns_allowed\": [\n    \"monalisa/octocat@*\",\n    \"docker/*\"\n  ]\n}\n
" } ] }, { - "verb": "patch", - "requestPath": "/gists/{gist_id}", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/permissions/selected-actions", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "gist_id", - "description": "gist_id parameter", + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

gist_id parameter

" + "descriptionHTML": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID \\\n -d '{\"description\":\"description\"}'", - "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID \\\n  -d '{\"description\":\"description\"}'
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/permissions/selected-actions \\\n -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"],\"verified_allowed\":true}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/permissions/selected-actions \\\n  -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"],\"verified_allowed\":true}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PATCH /gists/{gist_id}', {\n gist_id: 'gist_id',\n description: 'description'\n})", - "html": "
await octokit.request('PATCH /gists/{gist_id}', {\n  gist_id: 'gist_id',\n  description: 'description'\n})\n
" + "source": "await octokit.request('PUT /enterprises/{enterprise}/actions/permissions/selected-actions', {\n enterprise: 'enterprise',\n github_owned_allowed: true,\n patterns_allowed: [\n 'patterns_allowed'\n ],\n verified_allowed: true\n})", + "html": "
await octokit.request('PUT /enterprises/{enterprise}/actions/permissions/selected-actions', {\n  enterprise: 'enterprise',\n  github_owned_allowed: true,\n  patterns_allowed: [\n    'patterns_allowed'\n  ],\n  verified_allowed: true\n})\n
" } ], - "summary": "Update a gist", - "description": "Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.", + "summary": "Set allowed actions for an enterprise", + "description": "Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-allowed-actions-enterprise", "tags": [ - "gists" + "enterprise-admin" ], - "operationId": "gists/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#update-a-gist" + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise" }, "requestBody": { "content": { "application/json": { "schema": { + "type": "object", "properties": { - "description": { - "description": "

Description of the gist

", - "example": "Example Ruby script", - "type": "string", - "name": "description", + "github_owned_allowed": { + "type": "boolean", + "description": "

Required. Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", + "name": "github_owned_allowed", "in": "body", - "rawType": "string", - "rawDescription": "Description of the gist", + "rawType": "boolean", + "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", "childParamsGroups": [] }, - "files": { - "description": "

Names of files to be updated

", - "example": { - "hello.rb": { - "content": "blah", - "filename": "goodbye.rb" - } - }, - "type": "object", - "additionalProperties": { - "type": "object", - "nullable": true, - "properties": { - "content": { - "description": "The new content of the file", - "type": "string" - }, - "filename": { - "description": "The new filename for the file", - "type": "string", - "nullable": true - } - }, - "anyOf": [ - { - "required": [ - "content" - ] - }, - { - "required": [ - "filename" - ] - }, - { - "type": "object", - "maxProperties": 0 - } - ] + "verified_allowed": { + "type": "boolean", + "description": "

Required. Whether actions in GitHub Marketplace from verified creators are allowed. Set to true to allow all GitHub Marketplace actions by verified creators.

", + "name": "verified_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators.", + "childParamsGroups": [] + }, + "patterns_allowed": { + "type": "array of strings", + "description": "

Required. Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", + "items": { + "type": "string" }, - "name": "files", + "name": "patterns_allowed", "in": "body", - "rawType": "object", - "rawDescription": "Names of files to be updated", + "rawType": "array", + "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", "childParamsGroups": [] } }, - "anyOf": [ - { - "required": [ - "description" - ] - }, - { - "required": [ - "files" + "required": [ + "github_owned_allowed", + "patterns_allowed", + "verified_allowed" + ] + }, + "examples": { + "selected_actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" ] } - ], - "type": "object", - "nullable": true + } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": false, + "githubCloudOnly": false, "previews": [], - "category": "gists", - "subcategory": null + "category": "enterprise-admin", + "subcategory": "actions" }, - "slug": "update-a-gist", - "category": "gists", - "categoryLabel": "Gists", + "slug": "set-allowed-actions-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", "notes": [], - "descriptionHTML": "

Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.

", "responses": [ { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Default response", - "payload": "
{\n  \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n  \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n  \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n  \"id\": \"aa5a315d61ae9438b18d\",\n  \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n  \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n  \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n  \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n  \"created_at\": \"2010-04-14T02:15:15Z\",\n  \"updated_at\": \"2011-06-20T11:34:15Z\",\n  \"description\": \"Hello World Examples\",\n  \"comments\": 0,\n  \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"\n}\n
" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" } ], + "descriptionHTML": "

Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an enterprise.\"

\n

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

", "bodyParameters": [ { - "description": "

Description of the gist

", - "example": "Example Ruby script", - "type": "string", - "name": "description", + "type": "boolean", + "description": "

Required. Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", + "name": "github_owned_allowed", "in": "body", - "rawType": "string", - "rawDescription": "Description of the gist", + "rawType": "boolean", + "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", "childParamsGroups": [] }, { - "description": "

Names of files to be updated

", - "example": { - "hello.rb": { - "content": "blah", - "filename": "goodbye.rb" - } - }, - "type": "object", - "additionalProperties": { - "type": "object", - "nullable": true, - "properties": { - "content": { - "description": "The new content of the file", - "type": "string" - }, - "filename": { - "description": "The new filename for the file", - "type": "string", - "nullable": true - } - }, - "anyOf": [ - { - "required": [ - "content" - ] - }, - { - "required": [ - "filename" - ] - }, - { - "type": "object", - "maxProperties": 0 - } - ] + "type": "boolean", + "description": "

Required. Whether actions in GitHub Marketplace from verified creators are allowed. Set to true to allow all GitHub Marketplace actions by verified creators.

", + "name": "verified_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

Required. Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", + "items": { + "type": "string" }, - "name": "files", + "name": "patterns_allowed", "in": "body", - "rawType": "object", - "rawDescription": "Names of files to be updated", + "rawType": "array", + "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", "childParamsGroups": [] } ] }, { - "verb": "delete", - "requestPath": "/gists/{gist_id}", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "gist_id", - "description": "gist_id parameter", + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

gist_id parameter

" + "descriptionHTML": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /gists/{gist_id}', {\n gist_id: 'gist_id'\n})", - "html": "
await octokit.request('DELETE /gists/{gist_id}', {\n  gist_id: 'gist_id'\n})\n
" + "source": "await octokit.request('GET /enterprises/{enterprise}/actions/runner-groups', {\n enterprise: 'enterprise'\n})", + "html": "
await octokit.request('GET /enterprises/{enterprise}/actions/runner-groups', {\n  enterprise: 'enterprise'\n})\n
" } ], - "summary": "Delete a gist", - "description": "", + "summary": "List self-hosted runner groups for an enterprise", + "description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise", "tags": [ - "gists" + "enterprise-admin" ], - "operationId": "gists/delete", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#delete-a-gist" + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-self-hosted-runner-groups-for-an-enterprise" }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": false, + "githubCloudOnly": false, "previews": [], - "category": "gists", - "subcategory": null + "category": "enterprise-admin", + "subcategory": "actions" }, - "slug": "delete-a-gist", - "category": "gists", - "categoryLabel": "Gists", + "slug": "list-self-hosted-runner-groups-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Lists all self-hosted runner groups for an enterprise.

\n

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

", "responses": [ { - "httpStatusCode": "204", - "httpStatusMessage": "No Content", - "description": "Default Response" - }, + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"total_count\": 3,\n  \"runner_groups\": [\n    {\n      \"id\": 1,\n      \"name\": \"Default\",\n      \"visibility\": \"all\",\n      \"default\": true,\n      \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner_groups/1/runners\",\n      \"allows_public_repositories\": false\n    },\n    {\n      \"id\": 2,\n      \"name\": \"octo-runner-group\",\n      \"visibility\": \"selected\",\n      \"default\": false,\n      \"selected_organizations_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/organizations\",\n      \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/runners\",\n      \"allows_public_repositories\": true\n    },\n    {\n      \"id\": 3,\n      \"name\": \"expensive-hardware\",\n      \"visibility\": \"private\",\n      \"default\": false,\n      \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner_groups/3/runners\",\n      \"allows_public_repositories\": true\n    }\n  ]\n}\n
" + } + ] + }, + { + "verb": "post", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups", + "serverUrl": "https://api.github.com", + "parameters": [ { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - } - ], - "bodyParameters": [], - "descriptionHTML": "" - }, - { - "verb": "get", - "requestPath": "/gists/{gist_id}/comments", - "serverUrl": "https://api.github.com", - "parameters": [ - { - "name": "gist_id", - "description": "gist_id parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

gist_id parameter

" - }, - { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - }, - "descriptionHTML": "

Results per page (max 100).

" - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - }, - "descriptionHTML": "

Page number of the results to fetch.

" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('GET /gists/{gist_id}/comments', {\n gist_id: 'gist_id'\n})", - "html": "
await octokit.request('GET /gists/{gist_id}/comments', {\n  gist_id: 'gist_id'\n})\n
" - } - ], - "summary": "List gist comments", - "description": "", - "tags": [ - "gists" - ], - "operationId": "gists/list-comments", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gists#list-gist-comments" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "previews": [], - "category": "gists", - "subcategory": "comments" - }, - "slug": "list-gist-comments", - "category": "gists", - "categoryLabel": "Gists", - "subcategory": "comments", - "subcategoryLabel": "Comments", - "notes": [], - "bodyParameters": [], - "descriptionHTML": "", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Default response", - "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDExOkdpc3RDb21tZW50MQ==\",\n    \"url\": \"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\n    \"body\": \"Just commenting for the sake of commenting\",\n    \"user\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"created_at\": \"2011-04-18T23:23:56Z\",\n    \"updated_at\": \"2011-04-18T23:23:56Z\",\n    \"author_association\": \"COLLABORATOR\"\n  }\n]\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - } - ] - }, - { - "verb": "post", - "requestPath": "/gists/{gist_id}/comments", - "serverUrl": "https://api.github.com", - "parameters": [ - { - "name": "gist_id", - "description": "gist_id parameter", + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

gist_id parameter

" + "descriptionHTML": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments \\\n  -d '{\"body\":\"body\"}'
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups \\\n -d '{\"name\":\"name\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups \\\n  -d '{\"name\":\"name\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /gists/{gist_id}/comments', {\n gist_id: 'gist_id',\n body: 'body'\n})", - "html": "
await octokit.request('POST /gists/{gist_id}/comments', {\n  gist_id: 'gist_id',\n  body: 'body'\n})\n
" + "source": "await octokit.request('POST /enterprises/{enterprise}/actions/runner-groups', {\n enterprise: 'enterprise',\n name: 'name'\n})", + "html": "
await octokit.request('POST /enterprises/{enterprise}/actions/runner-groups', {\n  enterprise: 'enterprise',\n  name: 'name'\n})\n
" } ], - "summary": "Create a gist comment", - "description": "", + "summary": "Create a self-hosted runner group for an enterprise", + "description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise", "tags": [ - "gists" + "enterprise-admin" ], - "operationId": "gists/create-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gists#create-a-gist-comment" + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#create-self-hosted-runner-group-for-an-enterprise" }, "requestBody": { "content": { "application/json": { "schema": { + "type": "object", "properties": { - "body": { - "description": "

Required. The comment text.

", + "name": { + "description": "

Required. Name of the runner group.

", "type": "string", - "maxLength": 65535, - "example": "Body of the attachment", - "name": "body", + "name": "name", "in": "body", "rawType": "string", - "rawDescription": "The comment text.", + "rawDescription": "Name of the runner group.", + "childParamsGroups": [] + }, + "visibility": { + "description": "

Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: all or selected

", + "type": "string", + "enum": [ + "selected", + "all" + ], + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: `all` or `selected`", + "childParamsGroups": [] + }, + "selected_organization_ids": { + "description": "

List of organization IDs that can access the runner group.

", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the organization." + }, + "name": "selected_organization_ids", + "in": "body", + "rawType": "array", + "rawDescription": "List of organization IDs that can access the runner group.", + "childParamsGroups": [] + }, + "runners": { + "description": "

List of runner IDs to add to the runner group.

", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + }, + "name": "runners", + "in": "body", + "rawType": "array", + "rawDescription": "List of runner IDs to add to the runner group.", "childParamsGroups": [] } }, - "type": "object", "required": [ - "body" + "name" + ] + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected", + "selected_organization_ids": [ + 32, + 91 + ], + "runners": [ + 9, + 2 ] } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": false, + "githubCloudOnly": false, "previews": [], - "category": "gists", - "subcategory": "comments" + "category": "enterprise-admin", + "subcategory": "actions" }, - "slug": "create-a-gist-comment", - "category": "gists", - "categoryLabel": "Gists", - "subcategory": "comments", - "subcategoryLabel": "Comments", + "slug": "create-a-self-hosted-runner-group-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", "notes": [], - "descriptionHTML": "", + "descriptionHTML": "

Creates a new self-hosted runner group for an enterprise.

\n

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

", "bodyParameters": [ { - "description": "

Required. The comment text.

", + "description": "

Required. Name of the runner group.

", "type": "string", - "maxLength": 65535, - "example": "Body of the attachment", - "name": "body", + "name": "name", "in": "body", "rawType": "string", - "rawDescription": "The comment text.", + "rawDescription": "Name of the runner group.", + "childParamsGroups": [] + }, + { + "description": "

Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: all or selected

", + "type": "string", + "enum": [ + "selected", + "all" + ], + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: `all` or `selected`", + "childParamsGroups": [] + }, + { + "description": "

List of organization IDs that can access the runner group.

", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the organization." + }, + "name": "selected_organization_ids", + "in": "body", + "rawType": "array", + "rawDescription": "List of organization IDs that can access the runner group.", + "childParamsGroups": [] + }, + { + "description": "

List of runner IDs to add to the runner group.

", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + }, + "name": "runners", + "in": "body", + "rawType": "array", + "rawDescription": "List of runner IDs to add to the runner group.", "childParamsGroups": [] } ], @@ -7662,209 +7501,204 @@ "httpStatusCode": "201", "httpStatusMessage": "Created", "description": "Default response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDExOkdpc3RDb21tZW50MQ==\",\n  \"url\": \"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\n  \"body\": \"Just commenting for the sake of commenting\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2011-04-18T23:23:56Z\",\n  \"updated_at\": \"2011-04-18T23:23:56Z\",\n  \"author_association\": \"COLLABORATOR\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "payload": "
{\n  \"id\": 2,\n  \"name\": \"octo-runner-group\",\n  \"visibility\": \"selected\",\n  \"default\": false,\n  \"selected_organizations_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations\",\n  \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners\",\n  \"allows_public_repositories\": false\n}\n
" } ] }, { "verb": "get", - "requestPath": "/gists/{gist_id}/comments/{comment_id}", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "gist_id", - "description": "gist_id parameter", + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

gist_id parameter

" + "descriptionHTML": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

" }, { - "name": "comment_id", - "description": "comment_id parameter", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "

comment_id parameter

" + "descriptionHTML": "

Unique identifier of the self-hosted runner group.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /gists/{gist_id}/comments/{comment_id}', {\n gist_id: 'gist_id',\n comment_id: 42\n})", - "html": "
await octokit.request('GET /gists/{gist_id}/comments/{comment_id}', {\n  gist_id: 'gist_id',\n  comment_id: 42\n})\n
" + "source": "await octokit.request('GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}', {\n enterprise: 'enterprise',\n runner_group_id: 42\n})", + "html": "
await octokit.request('GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}', {\n  enterprise: 'enterprise',\n  runner_group_id: 42\n})\n
" } ], - "summary": "Get a gist comment", - "description": "", + "summary": "Get a self-hosted runner group for an enterprise", + "description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise", "tags": [ - "gists" + "enterprise-admin" ], - "operationId": "gists/get-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gists#get-a-gist-comment" + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-a-self-hosted-runner-group-for-an-enterprise" }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": false, + "githubCloudOnly": false, "previews": [], - "category": "gists", - "subcategory": "comments" + "category": "enterprise-admin", + "subcategory": "actions" }, - "slug": "get-a-gist-comment", - "category": "gists", - "categoryLabel": "Gists", - "subcategory": "comments", - "subcategoryLabel": "Comments", + "slug": "get-a-self-hosted-runner-group-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", "notes": [], "bodyParameters": [], - "descriptionHTML": "", + "descriptionHTML": "

Gets a specific self-hosted runner group for an enterprise.

\n

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDExOkdpc3RDb21tZW50MQ==\",\n  \"url\": \"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\n  \"body\": \"Just commenting for the sake of commenting\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2011-04-18T23:23:56Z\",\n  \"updated_at\": \"2011-04-18T23:23:56Z\",\n  \"author_association\": \"COLLABORATOR\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden gist" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "payload": "
{\n  \"id\": 2,\n  \"name\": \"octo-runner-group\",\n  \"visibility\": \"selected\",\n  \"default\": false,\n  \"selected_organizations_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations\",\n  \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners\",\n  \"allows_public_repositories\": false\n}\n
" } ] }, { "verb": "patch", - "requestPath": "/gists/{gist_id}/comments/{comment_id}", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "gist_id", - "description": "gist_id parameter", + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

gist_id parameter

" + "descriptionHTML": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

" }, { - "name": "comment_id", - "description": "comment_id parameter", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "

comment_id parameter

" + "descriptionHTML": "

Unique identifier of the self-hosted runner group.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42 \\\n  -d '{\"body\":\"body\"}'
" + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42 \\\n  -d '{\"name\":\"name\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PATCH /gists/{gist_id}/comments/{comment_id}', {\n gist_id: 'gist_id',\n comment_id: 42,\n body: 'body'\n})", - "html": "
await octokit.request('PATCH /gists/{gist_id}/comments/{comment_id}', {\n  gist_id: 'gist_id',\n  comment_id: 42,\n  body: 'body'\n})\n
" + "source": "await octokit.request('PATCH /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}', {\n enterprise: 'enterprise',\n runner_group_id: 42,\n name: 'name'\n})", + "html": "
await octokit.request('PATCH /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}', {\n  enterprise: 'enterprise',\n  runner_group_id: 42,\n  name: 'name'\n})\n
" } ], - "summary": "Update a gist comment", - "description": "", + "summary": "Update a self-hosted runner group for an enterprise", + "description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise", "tags": [ - "gists" + "enterprise-admin" ], - "operationId": "gists/update-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gists#update-a-gist-comment" + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#update-a-self-hosted-runner-group-for-an-enterprise" }, "requestBody": { "content": { "application/json": { "schema": { + "type": "object", "properties": { - "body": { - "description": "

Required. The comment text.

", + "name": { + "description": "

Name of the runner group.

", "type": "string", - "maxLength": 65535, - "example": "Body of the attachment", - "name": "body", + "name": "name", "in": "body", "rawType": "string", - "rawDescription": "The comment text.", + "rawDescription": "Name of the runner group.", + "childParamsGroups": [] + }, + "visibility": { + "description": "

Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: all or selected

", + "type": "string", + "enum": [ + "selected", + "all" + ], + "default": "all", + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: `all` or `selected`", "childParamsGroups": [] } - }, - "type": "object", - "required": [ - "body" - ] + } + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected" } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": false, + "githubCloudOnly": false, "previews": [], - "category": "gists", - "subcategory": "comments" + "category": "enterprise-admin", + "subcategory": "actions" }, - "slug": "update-a-gist-comment", - "category": "gists", - "categoryLabel": "Gists", - "subcategory": "comments", - "subcategoryLabel": "Comments", + "slug": "update-a-self-hosted-runner-group-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", "notes": [], - "descriptionHTML": "", + "descriptionHTML": "

Updates the name and visibility of a self-hosted runner group in an enterprise.

\n

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

", "bodyParameters": [ { - "description": "

Required. The comment text.

", + "description": "

Name of the runner group.

", "type": "string", - "maxLength": 65535, - "example": "Body of the attachment", - "name": "body", + "name": "name", "in": "body", "rawType": "string", - "rawDescription": "The comment text.", + "rawDescription": "Name of the runner group.", + "childParamsGroups": [] + }, + { + "description": "

Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: all or selected

", + "type": "string", + "enum": [ + "selected", + "all" + ], + "default": "all", + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: `all` or `selected`", "childParamsGroups": [] } ], @@ -7873,115 +7707,105 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDExOkdpc3RDb21tZW50MQ==\",\n  \"url\": \"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\n  \"body\": \"Just commenting for the sake of commenting\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2011-04-18T23:23:56Z\",\n  \"updated_at\": \"2011-04-18T23:23:56Z\",\n  \"author_association\": \"COLLABORATOR\"\n}\n
" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "payload": "
{\n  \"id\": 2,\n  \"name\": \"Expensive hardware runners\",\n  \"visibility\": \"selected\",\n  \"default\": false,\n  \"selected_organizations_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations\",\n  \"runners_url\": \"https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners\",\n  \"allows_public_repositories\": true\n}\n
" } ] }, { "verb": "delete", - "requestPath": "/gists/{gist_id}/comments/{comment_id}", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "gist_id", - "description": "gist_id parameter", + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

gist_id parameter

" + "descriptionHTML": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

" }, { - "name": "comment_id", - "description": "comment_id parameter", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "

comment_id parameter

" + "descriptionHTML": "

Unique identifier of the self-hosted runner group.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /gists/{gist_id}/comments/{comment_id}', {\n gist_id: 'gist_id',\n comment_id: 42\n})", - "html": "
await octokit.request('DELETE /gists/{gist_id}/comments/{comment_id}', {\n  gist_id: 'gist_id',\n  comment_id: 42\n})\n
" + "source": "await octokit.request('DELETE /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}', {\n enterprise: 'enterprise',\n runner_group_id: 42\n})", + "html": "
await octokit.request('DELETE /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}', {\n  enterprise: 'enterprise',\n  runner_group_id: 42\n})\n
" } ], - "summary": "Delete a gist comment", - "description": "", + "summary": "Delete a self-hosted runner group from an enterprise", + "description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise", "tags": [ - "gists" + "enterprise-admin" ], - "operationId": "gists/delete-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gists#delete-a-gist-comment" + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#delete-a-self-hosted-runner-group-from-an-enterprise" }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": false, + "githubCloudOnly": false, "previews": [], - "category": "gists", - "subcategory": "comments" + "category": "enterprise-admin", + "subcategory": "actions" }, - "slug": "delete-a-gist-comment", - "category": "gists", - "categoryLabel": "Gists", - "subcategory": "comments", - "subcategoryLabel": "Comments", + "slug": "delete-a-self-hosted-runner-group-from-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", "notes": [], "responses": [ { "httpStatusCode": "204", "httpStatusMessage": "No Content", "description": "Default Response" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" } ], "bodyParameters": [], - "descriptionHTML": "" + "descriptionHTML": "

Deletes a self-hosted runner group for an enterprise.

\n

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

" }, { "verb": "get", - "requestPath": "/gists/{gist_id}/commits", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "gist_id", - "description": "gist_id parameter", + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

gist_id parameter

" + "descriptionHTML": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

" + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

Unique identifier of the self-hosted runner group.

" }, { "name": "per_page", @@ -8007,666 +7831,706 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/commits", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/commits
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /gists/{gist_id}/commits', {\n gist_id: 'gist_id'\n})", - "html": "
await octokit.request('GET /gists/{gist_id}/commits', {\n  gist_id: 'gist_id'\n})\n
" + "source": "await octokit.request('GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners', {\n enterprise: 'enterprise',\n runner_group_id: 42\n})", + "html": "
await octokit.request('GET /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners', {\n  enterprise: 'enterprise',\n  runner_group_id: 42\n})\n
" } ], - "summary": "List gist commits", - "description": "", + "summary": "List self-hosted runners in a group for an enterprise", + "description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise", "tags": [ - "gists" + "enterprise-admin" ], - "operationId": "gists/list-commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#list-gist-commits" + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-self-hosted-runners-in-a-group-for-an-enterprise" }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": false, + "githubCloudOnly": false, "previews": [], - "category": "gists", - "subcategory": null + "category": "enterprise-admin", + "subcategory": "actions" }, - "slug": "list-gist-commits", - "category": "gists", - "categoryLabel": "Gists", + "slug": "list-self-hosted-runners-in-a-group-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", "notes": [], "bodyParameters": [], - "descriptionHTML": "", + "descriptionHTML": "

Lists the self-hosted runners that are in a specific enterprise group.

\n

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\n    \"version\": \"57a7f021a713b1c5a6a199b54cc514735d2d462f\",\n    \"user\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"change_status\": {\n      \"deletions\": 0,\n      \"additions\": 180,\n      \"total\": 180\n    },\n    \"committed_at\": \"2010-04-14T02:15:15Z\"\n  }\n]\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "payload": "
{\n  \"total_count\": 2,\n  \"runners\": [\n    {\n      \"id\": 23,\n      \"name\": \"linux_runner\",\n      \"os\": \"linux\",\n      \"status\": \"online\",\n      \"busy\": true,\n      \"labels\": [\n        {\n          \"id\": 5,\n          \"name\": \"self-hosted\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 7,\n          \"name\": \"X64\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 11,\n          \"name\": \"Linux\",\n          \"type\": \"read-only\"\n        }\n      ]\n    },\n    {\n      \"id\": 24,\n      \"name\": \"mac_runner\",\n      \"os\": \"macos\",\n      \"status\": \"offline\",\n      \"busy\": false,\n      \"labels\": [\n        {\n          \"id\": 5,\n          \"name\": \"self-hosted\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 7,\n          \"name\": \"X64\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 20,\n          \"name\": \"macOS\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 21,\n          \"name\": \"no-gpu\",\n          \"type\": \"custom\"\n        }\n      ]\n    }\n  ]\n}\n
" } ] }, { - "verb": "get", - "requestPath": "/gists/{gist_id}/forks", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "gist_id", - "description": "gist_id parameter", + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

gist_id parameter

" - }, - { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - }, - "descriptionHTML": "

Results per page (max 100).

" + "descriptionHTML": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

" }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" }, - "descriptionHTML": "

Page number of the results to fetch.

" + "descriptionHTML": "

Unique identifier of the self-hosted runner group.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/forks
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners \\\n -d '{\"runners\":[42]}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners \\\n  -d '{\"runners\":[42]}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /gists/{gist_id}/forks', {\n gist_id: 'gist_id'\n})", - "html": "
await octokit.request('GET /gists/{gist_id}/forks', {\n  gist_id: 'gist_id'\n})\n
" + "source": "await octokit.request('PUT /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners', {\n enterprise: 'enterprise',\n runner_group_id: 42,\n runners: [\n 42\n ]\n})", + "html": "
await octokit.request('PUT /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners', {\n  enterprise: 'enterprise',\n  runner_group_id: 42,\n  runners: [\n    42\n  ]\n})\n
" } ], - "summary": "List gist forks", - "description": "", + "summary": "Set self-hosted runners in a group for an enterprise", + "description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise", "tags": [ - "gists" + "enterprise-admin" ], - "operationId": "gists/list-forks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#list-gist-forks" + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-self-hosted-runners-in-a-group-for-an-enterprise" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "runners": { + "description": "

Required. List of runner IDs to add to the runner group.

", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + }, + "name": "runners", + "in": "body", + "rawType": "array", + "rawDescription": "List of runner IDs to add to the runner group.", + "childParamsGroups": [] + } + }, + "required": [ + "runners" + ] + }, + "example": { + "runners": [ + 9, + 2 + ] + } + } + } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": false, + "githubCloudOnly": false, "previews": [], - "category": "gists", - "subcategory": null + "category": "enterprise-admin", + "subcategory": "actions" }, - "slug": "list-gist-forks", - "category": "gists", - "categoryLabel": "Gists", + "slug": "set-self-hosted-runners-in-a-group-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", "notes": [], - "bodyParameters": [], - "descriptionHTML": "", "responses": [ { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Default response", - "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n    \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n    \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n    \"id\": \"aa5a315d61ae9438b18d\",\n    \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n    \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n    \"files\": {\n      \"hello_world.rb\": {\n        \"filename\": \"hello_world.rb\",\n        \"type\": \"application/x-ruby\",\n        \"language\": \"Ruby\",\n        \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n        \"size\": 167\n      }\n    },\n    \"public\": true,\n    \"created_at\": \"2010-04-14T02:15:15Z\",\n    \"updated_at\": \"2011-06-20T11:34:15Z\",\n    \"description\": \"Hello World Examples\",\n    \"comments\": 1,\n    \"user\": null,\n    \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  }\n]\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "descriptionHTML": "

Replaces the list of self-hosted runners that are part of an enterprise runner group.

\n

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

", + "bodyParameters": [ { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "description": "

Required. List of runner IDs to add to the runner group.

", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + }, + "name": "runners", + "in": "body", + "rawType": "array", + "rawDescription": "List of runner IDs to add to the runner group.", + "childParamsGroups": [] } ] }, { - "verb": "post", - "requestPath": "/gists/{gist_id}/forks", + "verb": "put", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "gist_id", - "description": "gist_id parameter", + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

gist_id parameter

" + "descriptionHTML": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

" + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

Unique identifier of the self-hosted runner group.

" + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

Unique identifier of the self-hosted runner.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/forks
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /gists/{gist_id}/forks', {\n gist_id: 'gist_id'\n})", - "html": "
await octokit.request('POST /gists/{gist_id}/forks', {\n  gist_id: 'gist_id'\n})\n
" + "source": "await octokit.request('PUT /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}', {\n enterprise: 'enterprise',\n runner_group_id: 42,\n runner_id: 42\n})", + "html": "
await octokit.request('PUT /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}', {\n  enterprise: 'enterprise',\n  runner_group_id: 42,\n  runner_id: 42\n})\n
" } ], - "summary": "Fork a gist", - "description": "**Note**: This was previously `/gists/:gist_id/fork`.", + "summary": "Add a self-hosted runner to a group for an enterprise", + "description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.", + "operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise", "tags": [ - "gists" + "enterprise-admin" ], - "operationId": "gists/fork", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#fork-a-gist" + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#add-a-self-hosted-runner-to-a-group-for-an-enterprise" }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": false, + "githubCloudOnly": false, "previews": [], - "category": "gists", - "subcategory": null + "category": "enterprise-admin", + "subcategory": "actions" }, - "slug": "fork-a-gist", - "category": "gists", - "categoryLabel": "Gists", + "slug": "add-a-self-hosted-runner-to-a-group-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Note: This was previously /gists/:gist_id/fork.

", "responses": [ { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Default response", - "payload": "
{\n  \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n  \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n  \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n  \"id\": \"aa5a315d61ae9438b18d\",\n  \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n  \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n  \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n  \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n  \"files\": {\n    \"hello_world.rb\": {\n      \"filename\": \"hello_world.rb\",\n      \"type\": \"application/x-ruby\",\n      \"language\": \"Ruby\",\n      \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n      \"size\": 167\n    }\n  },\n  \"public\": true,\n  \"created_at\": \"2010-04-14T02:15:15Z\",\n  \"updated_at\": \"2011-06-20T11:34:15Z\",\n  \"description\": \"Hello World Examples\",\n  \"comments\": 0,\n  \"user\": null,\n  \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n  \"owner\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"truncated\": false\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

Adds a self-hosted runner to a runner group configured in an enterprise.

\n

You must authenticate using an access token with the admin:enterprise\nscope to use this endpoint.

" }, { - "verb": "get", - "requestPath": "/gists/{gist_id}/star", + "verb": "delete", + "requestPath": "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "gist_id", - "description": "gist_id parameter", + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

gist_id parameter

" + "descriptionHTML": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

" + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

Unique identifier of the self-hosted runner group.

" + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

Unique identifier of the self-hosted runner.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runner-groups/42/runners/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /gists/{gist_id}/star', {\n gist_id: 'gist_id'\n})", - "html": "
await octokit.request('GET /gists/{gist_id}/star', {\n  gist_id: 'gist_id'\n})\n
" + "source": "await octokit.request('DELETE /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}', {\n enterprise: 'enterprise',\n runner_group_id: 42,\n runner_id: 42\n})", + "html": "
await octokit.request('DELETE /enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}', {\n  enterprise: 'enterprise',\n  runner_group_id: 42,\n  runner_id: 42\n})\n
" } ], - "summary": "Check if a gist is starred", - "description": "", + "summary": "Remove a self-hosted runner from a group for an enterprise", + "description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise", "tags": [ - "gists" + "enterprise-admin" ], - "operationId": "gists/check-is-starred", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#check-if-a-gist-is-starred" + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#remove-a-self-hosted-runner-from-a-group-for-an-enterprise" }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": false, + "githubCloudOnly": false, "previews": [], - "category": "gists", - "subcategory": null + "category": "enterprise-admin", + "subcategory": "actions" }, - "slug": "check-if-a-gist-is-starred", - "category": "gists", - "categoryLabel": "Gists", + "slug": "remove-a-self-hosted-runner-from-a-group-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", "notes": [], "responses": [ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Response if gist is starred" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Response if gist is not starred" + "description": "Default Response" } ], "bodyParameters": [], - "descriptionHTML": "" + "descriptionHTML": "

Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.

\n

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

" }, { - "verb": "put", - "requestPath": "/gists/{gist_id}/star", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/runners", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "gist_id", - "description": "gist_id parameter", + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

gist_id parameter

" + "descriptionHTML": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runners", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runners
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /gists/{gist_id}/star', {\n gist_id: 'gist_id'\n})", - "html": "
await octokit.request('PUT /gists/{gist_id}/star', {\n  gist_id: 'gist_id'\n})\n
" + "source": "await octokit.request('GET /enterprises/{enterprise}/actions/runners', {\n enterprise: 'enterprise'\n})", + "html": "
await octokit.request('GET /enterprises/{enterprise}/actions/runners', {\n  enterprise: 'enterprise'\n})\n
" } ], - "summary": "Star a gist", - "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "summary": "List self-hosted runners for an enterprise", + "description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise", "tags": [ - "gists" + "enterprise-admin" ], - "operationId": "gists/star", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#star-a-gist" + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-self-hosted-runners-for-an-enterprise" }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": false, + "githubCloudOnly": false, "previews": [], - "category": "gists", - "subcategory": null + "category": "enterprise-admin", + "subcategory": "actions" }, - "slug": "star-a-gist", - "category": "gists", - "categoryLabel": "Gists", + "slug": "list-self-hosted-runners-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Lists all self-hosted runners configured for an enterprise.

\n

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

", "responses": [ { - "httpStatusCode": "204", - "httpStatusMessage": "No Content", - "description": "Default Response" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"total_count\": 2,\n  \"runners\": [\n    {\n      \"id\": 23,\n      \"name\": \"linux_runner\",\n      \"os\": \"linux\",\n      \"status\": \"online\",\n      \"busy\": true,\n      \"labels\": [\n        {\n          \"id\": 5,\n          \"name\": \"self-hosted\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 7,\n          \"name\": \"X64\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 11,\n          \"name\": \"Linux\",\n          \"type\": \"read-only\"\n        }\n      ]\n    },\n    {\n      \"id\": 24,\n      \"name\": \"mac_runner\",\n      \"os\": \"macos\",\n      \"status\": \"offline\",\n      \"busy\": false,\n      \"labels\": [\n        {\n          \"id\": 5,\n          \"name\": \"self-hosted\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 7,\n          \"name\": \"X64\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 20,\n          \"name\": \"macOS\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 21,\n          \"name\": \"no-gpu\",\n          \"type\": \"custom\"\n        }\n      ]\n    }\n  ]\n}\n
" } - ], - "bodyParameters": [], - "descriptionHTML": "

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

" + ] }, { - "verb": "delete", - "requestPath": "/gists/{gist_id}/star", + "verb": "get", + "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "gist_id", - "description": "gist_id parameter", + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

gist_id parameter

" + "descriptionHTML": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

" + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

Unique identifier of the self-hosted runner.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runners/42", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runners/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /gists/{gist_id}/star', {\n gist_id: 'gist_id'\n})", - "html": "
await octokit.request('DELETE /gists/{gist_id}/star', {\n  gist_id: 'gist_id'\n})\n
" + "source": "await octokit.request('GET /enterprises/{enterprise}/actions/runners/{runner_id}', {\n enterprise: 'enterprise',\n runner_id: 42\n})", + "html": "
await octokit.request('GET /enterprises/{enterprise}/actions/runners/{runner_id}', {\n  enterprise: 'enterprise',\n  runner_id: 42\n})\n
" } ], - "summary": "Unstar a gist", - "description": "", + "summary": "Get a self-hosted runner for an enterprise", + "description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise", "tags": [ - "gists" + "enterprise-admin" ], - "operationId": "gists/unstar", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#unstar-a-gist" + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-a-self-hosted-runner-for-an-enterprise" }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": false, + "githubCloudOnly": false, "previews": [], - "category": "gists", - "subcategory": null + "category": "enterprise-admin", + "subcategory": "actions" }, - "slug": "unstar-a-gist", - "category": "gists", - "categoryLabel": "Gists", + "slug": "get-a-self-hosted-runner-for-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Gets a specific self-hosted runner configured in an enterprise.

\n

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

", "responses": [ { - "httpStatusCode": "204", - "httpStatusMessage": "No Content", - "description": "Default Response" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"id\": 23,\n  \"name\": \"MBP\",\n  \"os\": \"macos\",\n  \"status\": \"online\",\n  \"busy\": true,\n  \"labels\": [\n    {\n      \"id\": 5,\n      \"name\": \"self-hosted\",\n      \"type\": \"read-only\"\n    },\n    {\n      \"id\": 7,\n      \"name\": \"X64\",\n      \"type\": \"read-only\"\n    },\n    {\n      \"id\": 20,\n      \"name\": \"macOS\",\n      \"type\": \"read-only\"\n    },\n    {\n      \"id\": 21,\n      \"name\": \"no-gpu\",\n      \"type\": \"custom\"\n    }\n  ]\n}\n
" } - ], - "bodyParameters": [], - "descriptionHTML": "" + ] }, { - "verb": "get", - "requestPath": "/gists/{gist_id}/{sha}", + "verb": "delete", + "requestPath": "/enterprises/{enterprise}/actions/runners/{runner_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "gist_id", - "description": "gist_id parameter", + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

gist_id parameter

" + "descriptionHTML": "

The slug version of the enterprise name. You can also substitute this value with the enterprise id.

" }, { - "name": "sha", + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" }, - "descriptionHTML": "" + "descriptionHTML": "

Unique identifier of the self-hosted runner.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/SHA", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/SHA
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/enterprises/ENTERPRISE/actions/runners/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/enterprises/ENTERPRISE/actions/runners/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /gists/{gist_id}/{sha}', {\n gist_id: 'gist_id',\n sha: 'sha'\n})", - "html": "
await octokit.request('GET /gists/{gist_id}/{sha}', {\n  gist_id: 'gist_id',\n  sha: 'sha'\n})\n
" + "source": "await octokit.request('DELETE /enterprises/{enterprise}/actions/runners/{runner_id}', {\n enterprise: 'enterprise',\n runner_id: 42\n})", + "html": "
await octokit.request('DELETE /enterprises/{enterprise}/actions/runners/{runner_id}', {\n  enterprise: 'enterprise',\n  runner_id: 42\n})\n
" } ], - "summary": "Get a gist revision", - "description": "", + "summary": "Delete a self-hosted runner from an enterprise", + "description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise", "tags": [ - "gists" + "enterprise-admin" ], - "operationId": "gists/get-revision", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#get-a-gist-revision" + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#delete-self-hosted-runner-from-an-enterprise" }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": false, + "githubCloudOnly": false, "previews": [], - "category": "gists", - "subcategory": null + "category": "enterprise-admin", + "subcategory": "actions" }, - "slug": "get-a-gist-revision", - "category": "gists", - "categoryLabel": "Gists", + "slug": "delete-a-self-hosted-runner-from-an-enterprise", + "category": "enterprise-admin", + "categoryLabel": "Enterprise admin", + "subcategory": "actions", + "subcategoryLabel": "Actions", "notes": [], - "bodyParameters": [], - "descriptionHTML": "", "responses": [ { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Default response", - "payload": "
{\n  \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n  \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n  \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n  \"id\": \"aa5a315d61ae9438b18d\",\n  \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n  \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n  \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n  \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n  \"created_at\": \"2010-04-14T02:15:15Z\",\n  \"updated_at\": \"2011-06-20T11:34:15Z\",\n  \"description\": \"Hello World Examples\",\n  \"comments\": 0,\n  \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"\n}\n
" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

\n

You must authenticate using an access token with the admin:enterprise scope to use this endpoint.

" }, { "verb": "get", - "requestPath": "/gitignore/templates", + "requestPath": "/events", "serverUrl": "https://api.github.com", - "parameters": [], + "parameters": [ + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + } + ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gitignore/templates
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/events", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/events
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /gitignore/templates')", - "html": "
await octokit.request('GET /gitignore/templates')\n
" + "source": "await octokit.request('GET /events')", + "html": "
await octokit.request('GET /events')\n
" } ], - "summary": "Get all gitignore templates", - "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-for-the-authenticated-user).", - "operationId": "gitignore/get-all-templates", + "summary": "List public events", + "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", "tags": [ - "gitignore" + "activity" ], + "operationId": "activity/list-public-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gitignore/#get-all-gitignore-templates" + "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#list-public-events" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "category": "gitignore", - "subcategory": null + "category": "activity", + "subcategory": "events" }, - "slug": "get-all-gitignore-templates", - "category": "gitignore", - "categoryLabel": "Gitignore", + "slug": "list-public-events", + "category": "activity", + "categoryLabel": "Activity", + "subcategory": "events", + "subcategoryLabel": "Events", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

List all templates available to pass as an option when creating a repository.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "Response", - "payload": "
[\n  \"Actionscript\",\n  \"Android\",\n  \"AppceleratorTitanium\",\n  \"Autotools\",\n  \"Bancha\",\n  \"C\",\n  \"C++\"\n]\n
" + "description": "Response" }, { "httpStatusCode": "304", "httpStatusMessage": "Not Modified", "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.

" }, { "verb": "get", - "requestPath": "/gitignore/templates/{name}", + "requestPath": "/feeds", "serverUrl": "https://api.github.com", - "parameters": [ - { - "name": "name", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - } - ], + "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates/NAME", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gitignore/templates/NAME
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/feeds", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/feeds
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /gitignore/templates/{name}', {\n name: 'name'\n})", - "html": "
await octokit.request('GET /gitignore/templates/{name}', {\n  name: 'name'\n})\n
" + "source": "await octokit.request('GET /feeds')", + "html": "
await octokit.request('GET /feeds')\n
" } ], - "summary": "Get a gitignore template", - "description": "The API also allows fetching the source of a single template.\nUse the raw [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types/) to get the raw contents.", - "operationId": "gitignore/get-template", + "summary": "Get feeds", + "description": "GitHub AE provides several timeline resources in [Atom](http://en.wikipedia.org/wiki/Atom_(standard)) format. The Feeds API lists all the feeds available to the authenticated user:\n\n* **Timeline**: The GitHub AE global public timeline\n* **User**: The public timeline for any user, using [URI template](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#hypermedia)\n* **Current user public**: The public timeline for the authenticated user\n* **Current user**: The private timeline for the authenticated user\n* **Current user actor**: The private timeline for activity created by the authenticated user\n* **Current user organizations**: The private timeline for the organizations the authenticated user is a member of.\n* **Security advisories**: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub AE.\n\n**Note**: Private feeds are only returned when [authenticating via Basic Auth](https://docs.github.com/github-ae@latest/rest/overview/other-authentication-methods#basic-authentication) since current feed URIs use the older, non revocable auth tokens.", "tags": [ - "gitignore" + "activity" ], + "operationId": "activity/get-feeds", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/gitignore/#get-a-gitignore-template" + "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#get-feeds" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "category": "gitignore", - "subcategory": null + "category": "activity", + "subcategory": "feeds" }, - "slug": "get-a-gitignore-template", - "category": "gitignore", - "categoryLabel": "Gitignore", + "slug": "get-feeds", + "category": "activity", + "categoryLabel": "Activity", + "subcategory": "feeds", + "subcategoryLabel": "Feeds", "notes": [], "bodyParameters": [], - "descriptionHTML": "

The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.

", + "descriptionHTML": "

GitHub AE provides several timeline resources in Atom format. The Feeds API lists all the feeds available to the authenticated user:

\n
    \n
  • Timeline: The GitHub AE global public timeline
    • \n
  • User: The public timeline for any user, using URI template
    • \n
  • Current user public: The public timeline for the authenticated user
    • \n
  • Current user: The private timeline for the authenticated user
    • \n
  • Current user actor: The private timeline for activity created by the authenticated user
    • \n
  • Current user organizations: The private timeline for the organizations the authenticated user is a member of.
    • \n
  • Security advisories: A collection of public announcements that provide information about security-related vulnerabilities in software on GitHub AE.
    • \n
\n

Note: Private feeds are only returned when authenticating via Basic Auth since current feed URIs use the older, non revocable auth tokens.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"name\": \"C\",\n  \"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\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" + "payload": "
{\n  \"timeline_url\": \"https://github.com/timeline\",\n  \"user_url\": \"https://github.com/{user}\",\n  \"current_user_public_url\": \"https://github.com/octocat\",\n  \"current_user_url\": \"https://github.com/octocat.private?token=abc123\",\n  \"current_user_actor_url\": \"https://github.com/octocat.private.actor?token=abc123\",\n  \"current_user_organization_url\": \"\",\n  \"current_user_organization_urls\": [\n    \"https://github.com/organizations/github/octocat.private.atom?token=abc123\"\n  ],\n  \"security_advisories_url\": \"https://github.com/security-advisories\",\n  \"_links\": {\n    \"timeline\": {\n      \"href\": \"https://github.com/timeline\",\n      \"type\": \"application/atom+xml\"\n    },\n    \"user\": {\n      \"href\": \"https://github.com/{user}\",\n      \"type\": \"application/atom+xml\"\n    },\n    \"current_user_public\": {\n      \"href\": \"https://github.com/octocat\",\n      \"type\": \"application/atom+xml\"\n    },\n    \"current_user\": {\n      \"href\": \"https://github.com/octocat.private?token=abc123\",\n      \"type\": \"application/atom+xml\"\n    },\n    \"current_user_actor\": {\n      \"href\": \"https://github.com/octocat.private.actor?token=abc123\",\n      \"type\": \"application/atom+xml\"\n    },\n    \"current_user_organization\": {\n      \"href\": \"\",\n      \"type\": \"\"\n    },\n    \"current_user_organizations\": [\n      {\n        \"href\": \"https://github.com/organizations/github/octocat.private.atom?token=abc123\",\n        \"type\": \"application/atom+xml\"\n      }\n    ],\n    \"security_advisories\": {\n      \"href\": \"https://github.com/security-advisories\",\n      \"type\": \"application/atom+xml\"\n    }\n  }\n}\n
" } ] }, { "verb": "get", - "requestPath": "/installation/repositories", + "requestPath": "/gists", "serverUrl": "https://api.github.com", "parameters": [ + { + "name": "since", + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + }, { "name": "per_page", "description": "Results per page (max 100).", @@ -8691,64 +8555,50 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/installation/repositories", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/installation/repositories
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /installation/repositories')", - "html": "
await octokit.request('GET /installation/repositories')\n
" + "source": "await octokit.request('GET /gists')", + "html": "
await octokit.request('GET /gists')\n
" } ], - "summary": "List repositories accessible to the app installation", - "description": "List repositories that an app installation can access.\n\nYou must use an [installation access token](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "summary": "List gists for the authenticated user", + "description": "Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:", "tags": [ - "apps" + "gists" ], - "operationId": "apps/list-repos-accessible-to-installation", + "operationId": "gists/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/apps#list-repositories-accessible-to-the-app-installation" + "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#list-gists-for-the-authenticated-user" }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "mercy", - "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", - "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" - } - ], - "category": "apps", - "subcategory": "installations" + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": null }, - "slug": "list-repositories-accessible-to-the-app-installation", - "category": "apps", - "categoryLabel": "Apps", - "subcategory": "installations", - "subcategoryLabel": "Installations", + "slug": "list-gists-for-the-authenticated-user", + "category": "gists", + "categoryLabel": "Gists", "notes": [], "bodyParameters": [], - "descriptionHTML": "

List repositories that an app installation can access.

\n

You must use an installation access token to access this endpoint.

", + "descriptionHTML": "

Lists the authenticated user's gists or if called anonymously, this endpoint returns all public gists:

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"total_count\": 1,\n  \"repositories\": [\n    {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World\",\n      \"full_name\": \"octocat/Hello-World\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"allow_rebase_merge\": true,\n      \"template_repository\": null,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://github.com/licenses/mit\"\n      },\n      \"forks\": 1,\n      \"open_issues\": 1,\n      \"watchers\": 1\n    }\n  ]\n}\n
" + "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n    \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n    \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n    \"id\": \"aa5a315d61ae9438b18d\",\n    \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n    \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n    \"files\": {\n      \"hello_world.rb\": {\n        \"filename\": \"hello_world.rb\",\n        \"type\": \"application/x-ruby\",\n        \"language\": \"Ruby\",\n        \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n        \"size\": 167\n      }\n    },\n    \"public\": true,\n    \"created_at\": \"2010-04-14T02:15:15Z\",\n    \"updated_at\": \"2011-06-20T11:34:15Z\",\n    \"description\": \"Hello World Examples\",\n    \"comments\": 0,\n    \"user\": null,\n    \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"truncated\": false\n  }\n]\n
" }, { "httpStatusCode": "304", "httpStatusMessage": "Not Modified", "description": "Not modified" }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", @@ -8757,180 +8607,223 @@ ] }, { - "verb": "delete", - "requestPath": "/installation/token", + "verb": "post", + "requestPath": "/gists", "serverUrl": "https://api.github.com", "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/installation/token", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/installation/token
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists \\\n -d '{\"files\":{}}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists \\\n  -d '{\"files\":{}}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /installation/token')", - "html": "
await octokit.request('DELETE /installation/token')\n
" + "source": "await octokit.request('POST /gists', {\n files: {}\n})", + "html": "
await octokit.request('POST /gists', {\n  files: {}\n})\n
" } ], - "summary": "Revoke an installation access token", - "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/github-ae@latest/rest/reference/apps#create-an-installation-access-token-for-an-app)\" endpoint.\n\nYou must use an [installation access token](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "summary": "Create a gist", + "description": "Allows you to add a new gist with one or more files.\n\n**Note:** Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.", + "operationId": "gists/create", "tags": [ - "apps" + "gists" ], - "operationId": "apps/revoke-installation-access-token", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/apps#revoke-an-installation-access-token" + "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#create-a-gist" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "description": { + "description": "

Description of the gist

", + "example": "Example Ruby script", + "type": "string", + "name": "description", + "in": "body", + "rawType": "string", + "rawDescription": "Description of the gist", + "childParamsGroups": [] + }, + "files": { + "description": "

Required. Names and content for the files that make up the gist

", + "example": { + "hello.rb": { + "content": "puts \"Hello, World!\"" + } + }, + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "content": { + "description": "Content of the file", + "readOnly": false, + "type": "string" + } + }, + "required": [ + "content" + ] + }, + "name": "files", + "in": "body", + "rawType": "object", + "rawDescription": "Names and content for the files that make up the gist", + "childParamsGroups": [] + }, + "public": { + "oneOf": [ + { + "description": "Flag indicating whether the gist is public", + "example": true, + "type": "boolean", + "default": false + }, + { + "type": "string", + "example": "true", + "default": "false", + "enum": [ + "true", + "false" + ] + } + ], + "name": "public", + "in": "body", + "description": "

undefined

", + "childParamsGroups": [] + } + }, + "required": [ + "files" + ], + "type": "object" + } + } + } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "previews": [], - "category": "apps", - "subcategory": "installations" + "category": "gists", + "subcategory": null }, - "slug": "revoke-an-installation-access-token", - "category": "apps", - "categoryLabel": "Apps", - "subcategory": "installations", - "subcategoryLabel": "Installations", + "slug": "create-a-gist", + "category": "gists", + "categoryLabel": "Gists", "notes": [], + "descriptionHTML": "

Allows you to add a new gist with one or more files.

\n

Note: Don't name your files \"gistfile\" with a numerical suffix. This is the format of the automatic naming scheme that Gist uses internally.

", "responses": [ { - "httpStatusCode": "204", - "httpStatusMessage": "No Content", - "description": "Default Response" - } - ], - "bodyParameters": [], - "descriptionHTML": "

Revokes the installation token you're using to authenticate as an installation and access this endpoint.

\n

Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"Create an installation access token for an app\" endpoint.

\n

You must use an installation access token to access this endpoint.

" - }, - { - "verb": "get", - "requestPath": "/issues", - "serverUrl": "https://api.github.com", - "parameters": [ - { - "name": "filter", - "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "assigned", - "created", - "mentioned", - "subscribed", - "all" - ], - "default": "assigned" - }, - "descriptionHTML": "

Indicates which sorts of issues to return. Can be one of:
\n* assigned: Issues assigned to you
\n* created: Issues created by you
\n* mentioned: Issues mentioning you
\n* subscribed: Issues you're subscribed to updates for
\n* all: All issues the authenticated user can see, regardless of participation or creation

" + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Default response", + "payload": "
{\n  \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n  \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n  \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n  \"id\": \"aa5a315d61ae9438b18d\",\n  \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n  \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n  \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n  \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n  \"created_at\": \"2010-04-14T02:15:15Z\",\n  \"updated_at\": \"2011-06-20T11:34:15Z\",\n  \"description\": \"Hello World Examples\",\n  \"comments\": 0,\n  \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"\n}\n
" }, { - "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - }, - "descriptionHTML": "

Indicates the state of the issues to return. Can be either open, closed, or all.

" + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" }, { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "in": "query", - "required": false, - "schema": { - "type": "string" - }, - "descriptionHTML": "

A list of comma separated label names. Example: bug,ui,@high

" + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" }, { - "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "comments" - ], - "default": "created" - }, - "descriptionHTML": "

What to sort results by. Can be either created, updated, comments.

" + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" }, { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - }, - "descriptionHTML": "

One of asc (ascending) or desc (descending).

" - }, + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ], + "bodyParameters": [ { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - }, - "descriptionHTML": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + "description": "

Description of the gist

", + "example": "Example Ruby script", + "type": "string", + "name": "description", + "in": "body", + "rawType": "string", + "rawDescription": "Description of the gist", + "childParamsGroups": [] }, { - "name": "collab", - "in": "query", - "required": false, - "schema": { - "type": "boolean" + "description": "

Required. Names and content for the files that make up the gist

", + "example": { + "hello.rb": { + "content": "puts \"Hello, World!\"" + } }, - "descriptionHTML": "" - }, - { - "name": "orgs", - "in": "query", - "required": false, - "schema": { - "type": "boolean" + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "content": { + "description": "Content of the file", + "readOnly": false, + "type": "string" + } + }, + "required": [ + "content" + ] }, - "descriptionHTML": "" + "name": "files", + "in": "body", + "rawType": "object", + "rawDescription": "Names and content for the files that make up the gist", + "childParamsGroups": [] }, { - "name": "owned", - "in": "query", - "required": false, - "schema": { - "type": "boolean" - }, - "descriptionHTML": "" - }, + "oneOf": [ + { + "description": "Flag indicating whether the gist is public", + "example": true, + "type": "boolean", + "default": false + }, + { + "type": "string", + "example": "true", + "default": "false", + "enum": [ + "true", + "false" + ] + } + ], + "name": "public", + "in": "body", + "description": "

undefined

", + "childParamsGroups": [] + } + ] + }, + { + "verb": "get", + "requestPath": "/gists/public", + "serverUrl": "https://api.github.com", + "parameters": [ { - "name": "pulls", + "name": "since", + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", "required": false, "schema": { - "type": "boolean" + "type": "string" }, - "descriptionHTML": "" + "descriptionHTML": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" }, { "name": "per_page", @@ -8956,51 +8849,44 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/issues", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/issues
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/public", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/public
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /issues')", - "html": "
await octokit.request('GET /issues')\n
" + "source": "await octokit.request('GET /gists/public')", + "html": "
await octokit.request('GET /gists/public')\n
" } ], - "summary": "List issues assigned to the authenticated user", - "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests)\" endpoint.", + "summary": "List public gists", + "description": "List public gists sorted by most recently updated to least recently updated.\n\nNote: With [pagination](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#pagination), you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.", "tags": [ - "issues" + "gists" ], - "operationId": "issues/list", + "operationId": "gists/list-public", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/issues/#list-issues-assigned-to-the-authenticated-user" + "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#list-public-gists" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, - "previews": [ - { - "required": false, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", - "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" - } - ], - "category": "issues", + "previews": [], + "category": "gists", "subcategory": null }, - "slug": "list-issues-assigned-to-the-authenticated-user", - "category": "issues", - "categoryLabel": "Issues", + "slug": "list-public-gists", + "category": "gists", + "categoryLabel": "Gists", "notes": [], "bodyParameters": [], - "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

List public gists sorted by most recently updated to least recently updated.

\n

Note: With pagination, you can fetch up to 3000 gists. For example, you can fetch 100 pages with 30 gists per page or 30 pages with 100 gists per page.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDU6SXNzdWUx\",\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n    \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n    \"number\": 1347,\n    \"state\": \"open\",\n    \"title\": \"Found a bug\",\n    \"body\": \"I'm having a problem with this.\",\n    \"user\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"labels\": [\n      {\n        \"id\": 208045946,\n        \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n        \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n        \"name\": \"bug\",\n        \"description\": \"Something isn't working\",\n        \"color\": \"f29513\",\n        \"default\": true\n      }\n    ],\n    \"assignee\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"assignees\": [\n      {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      }\n    ],\n    \"milestone\": {\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n      \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n      \"id\": 1002604,\n      \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n      \"number\": 1,\n      \"state\": \"open\",\n      \"title\": \"v1.0\",\n      \"description\": \"Tracking milestone for version 1.0\",\n      \"creator\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"open_issues\": 4,\n      \"closed_issues\": 8,\n      \"created_at\": \"2011-04-10T20:09:31Z\",\n      \"updated_at\": \"2014-03-03T18:58:10Z\",\n      \"closed_at\": \"2013-02-12T13:22:01Z\",\n      \"due_on\": \"2012-10-09T23:39:01Z\"\n    },\n    \"locked\": true,\n    \"active_lock_reason\": \"too heated\",\n    \"comments\": 0,\n    \"pull_request\": {\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n      \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n      \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n      \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n    },\n    \"closed_at\": null,\n    \"created_at\": \"2011-04-22T13:33:48Z\",\n    \"updated_at\": \"2011-04-22T13:33:48Z\",\n    \"repository\": {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World\",\n      \"full_name\": \"octocat/Hello-World\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"template_repository\": null,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://github.com/licenses/mit\"\n      },\n      \"forks\": 1,\n      \"open_issues\": 1,\n      \"watchers\": 1\n    },\n    \"author_association\": \"COLLABORATOR\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n    \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n    \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n    \"id\": \"aa5a315d61ae9438b18d\",\n    \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n    \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n    \"files\": {\n      \"hello_world.rb\": {\n        \"filename\": \"hello_world.rb\",\n        \"type\": \"application/x-ruby\",\n        \"language\": \"Ruby\",\n        \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n        \"size\": 167\n      }\n    },\n    \"public\": true,\n    \"created_at\": \"2010-04-14T02:15:15Z\",\n    \"updated_at\": \"2011-06-20T11:34:15Z\",\n    \"description\": \"Hello World Examples\",\n    \"comments\": 0,\n    \"user\": null,\n    \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"truncated\": false\n  }\n]\n
" }, { "httpStatusCode": "304", @@ -9008,9 +8894,9 @@ "description": "Not modified" }, { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" }, { "httpStatusCode": "422", @@ -9021,17 +8907,18 @@ }, { "verb": "get", - "requestPath": "/licenses", + "requestPath": "/gists/starred", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "featured", + "name": "since", + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", "in": "query", "required": false, "schema": { - "type": "boolean" + "type": "string" }, - "descriptionHTML": "" + "descriptionHTML": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" }, { "name": "per_page", @@ -9042,104 +8929,125 @@ "default": 30 }, "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/licenses", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/licenses
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/starred", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/starred
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /licenses')", - "html": "
await octokit.request('GET /licenses')\n
" + "source": "await octokit.request('GET /gists/starred')", + "html": "
await octokit.request('GET /gists/starred')\n
" } ], - "summary": "Get all commonly used licenses", - "description": "", + "summary": "List starred gists", + "description": "List the authenticated user's starred gists:", "tags": [ - "licenses" + "gists" ], - "operationId": "licenses/get-all-commonly-used", + "operationId": "gists/list-starred", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/licenses/#get-all-commonly-used-licenses" + "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#list-starred-gists" }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "previews": [], - "category": "licenses", + "category": "gists", "subcategory": null }, - "slug": "get-all-commonly-used-licenses", - "category": "licenses", - "categoryLabel": "Licenses", + "slug": "list-starred-gists", + "category": "gists", + "categoryLabel": "Gists", "notes": [], "bodyParameters": [], - "descriptionHTML": "", + "descriptionHTML": "

List the authenticated user's starred gists:

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"key\": \"mit\",\n    \"name\": \"MIT License\",\n    \"spdx_id\": \"MIT\",\n    \"url\": \"https://api.github.com/licenses/mit\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n  },\n  {\n    \"key\": \"lgpl-3.0\",\n    \"name\": \"GNU Lesser General Public License v3.0\",\n    \"spdx_id\": \"LGPL-3.0\",\n    \"url\": \"https://api.github.com/licenses/lgpl-3.0\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n  },\n  {\n    \"key\": \"mpl-2.0\",\n    \"name\": \"Mozilla Public License 2.0\",\n    \"spdx_id\": \"MPL-2.0\",\n    \"url\": \"https://api.github.com/licenses/mpl-2.0\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n  },\n  {\n    \"key\": \"agpl-3.0\",\n    \"name\": \"GNU Affero General Public License v3.0\",\n    \"spdx_id\": \"AGPL-3.0\",\n    \"url\": \"https://api.github.com/licenses/agpl-3.0\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n  },\n  {\n    \"key\": \"unlicense\",\n    \"name\": \"The Unlicense\",\n    \"spdx_id\": \"Unlicense\",\n    \"url\": \"https://api.github.com/licenses/unlicense\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n  },\n  {\n    \"key\": \"apache-2.0\",\n    \"name\": \"Apache License 2.0\",\n    \"spdx_id\": \"Apache-2.0\",\n    \"url\": \"https://api.github.com/licenses/apache-2.0\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n  },\n  {\n    \"key\": \"gpl-3.0\",\n    \"name\": \"GNU General Public License v3.0\",\n    \"spdx_id\": \"GPL-3.0\",\n    \"url\": \"https://api.github.com/licenses/gpl-3.0\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n    \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n    \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n    \"id\": \"aa5a315d61ae9438b18d\",\n    \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n    \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n    \"files\": {\n      \"hello_world.rb\": {\n        \"filename\": \"hello_world.rb\",\n        \"type\": \"application/x-ruby\",\n        \"language\": \"Ruby\",\n        \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n        \"size\": 167\n      }\n    },\n    \"public\": true,\n    \"created_at\": \"2010-04-14T02:15:15Z\",\n    \"updated_at\": \"2011-06-20T11:34:15Z\",\n    \"description\": \"Hello World Examples\",\n    \"comments\": 0,\n    \"user\": null,\n    \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"truncated\": false\n  }\n]\n
" }, { "httpStatusCode": "304", "httpStatusMessage": "Not Modified", "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" } ] }, { "verb": "get", - "requestPath": "/licenses/{license}", + "requestPath": "/gists/{gist_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "license", + "name": "gist_id", + "description": "gist_id parameter", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "" + "descriptionHTML": "

gist_id parameter

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/licenses/LICENSE", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/licenses/LICENSE
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /licenses/{license}', {\n license: 'license'\n})", - "html": "
await octokit.request('GET /licenses/{license}', {\n  license: 'license'\n})\n
" + "source": "await octokit.request('GET /gists/{gist_id}', {\n gist_id: 'gist_id'\n})", + "html": "
await octokit.request('GET /gists/{gist_id}', {\n  gist_id: 'gist_id'\n})\n
" } ], - "summary": "Get a license", + "summary": "Get a gist", "description": "", "tags": [ - "licenses" + "gists" ], - "operationId": "licenses/get", + "operationId": "gists/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/licenses/#get-a-license" + "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#get-a-gist" }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "previews": [], - "category": "licenses", + "category": "gists", "subcategory": null }, - "slug": "get-a-license", - "category": "licenses", - "categoryLabel": "Licenses", + "slug": "get-a-gist", + "category": "gists", + "categoryLabel": "Gists", "notes": [], "bodyParameters": [], "descriptionHTML": "", @@ -9148,7 +9056,7 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"key\": \"mit\",\n  \"name\": \"MIT License\",\n  \"spdx_id\": \"MIT\",\n  \"url\": \"https://api.github.com/licenses/mit\",\n  \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n  \"html_url\": \"http://choosealicense.com/licenses/mit/\",\n  \"description\": \"A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty.\",\n  \"implementation\": \"Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders.\",\n  \"permissions\": [\n    \"commercial-use\",\n    \"modifications\",\n    \"distribution\",\n    \"sublicense\",\n    \"private-use\"\n  ],\n  \"conditions\": [\n    \"include-copyright\"\n  ],\n  \"limitations\": [\n    \"no-liability\"\n  ],\n  \"body\": \"\\n\\nThe MIT License (MIT)\\n\\nCopyright (c) [year] [fullname]\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in all\\ncopies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\\nSOFTWARE.\\n\",\n  \"featured\": true\n}\n
" + "payload": "
{\n  \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n  \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n  \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n  \"id\": \"aa5a315d61ae9438b18d\",\n  \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n  \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n  \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n  \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n  \"created_at\": \"2010-04-14T02:15:15Z\",\n  \"updated_at\": \"2011-06-20T11:34:15Z\",\n  \"description\": \"Hello World Examples\",\n  \"comments\": 0,\n  \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"\n}\n
" }, { "httpStatusCode": "304", @@ -9158,7 +9066,7 @@ { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Forbidden" + "description": "Forbidden gist" }, { "httpStatusCode": "404", @@ -9168,282 +9076,300 @@ ] }, { - "verb": "post", - "requestPath": "/markdown", + "verb": "patch", + "requestPath": "/gists/{gist_id}", "serverUrl": "https://api.github.com", - "parameters": [], + "parameters": [ + { + "name": "gist_id", + "description": "gist_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

gist_id parameter

" + } + ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown \\\n -d '{\"text\":\"text\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/markdown \\\n  -d '{\"text\":\"text\"}'
" + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID \\\n -d '{\"description\":\"description\"}'", + "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID \\\n  -d '{\"description\":\"description\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /markdown', {\n text: 'text'\n})", - "html": "
await octokit.request('POST /markdown', {\n  text: 'text'\n})\n
" + "source": "await octokit.request('PATCH /gists/{gist_id}', {\n gist_id: 'gist_id',\n description: 'description'\n})", + "html": "
await octokit.request('PATCH /gists/{gist_id}', {\n  gist_id: 'gist_id',\n  description: 'description'\n})\n
" } ], - "summary": "Render a Markdown document", - "description": "", - "operationId": "markdown/render", + "summary": "Update a gist", + "description": "Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.", "tags": [ - "markdown" + "gists" ], + "operationId": "gists/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/markdown/#render-a-markdown-document" + "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#update-a-gist" }, "requestBody": { "content": { "application/json": { "schema": { "properties": { - "text": { - "description": "

Required. The Markdown text to render in HTML.

", - "type": "string", - "name": "text", - "in": "body", - "rawType": "string", - "rawDescription": "The Markdown text to render in HTML.", - "childParamsGroups": [] - }, - "mode": { - "description": "

The rendering mode.

", - "enum": [ - "markdown", - "gfm" - ], - "default": "markdown", - "example": "markdown", + "description": { + "description": "

Description of the gist

", + "example": "Example Ruby script", "type": "string", - "name": "mode", + "name": "description", "in": "body", "rawType": "string", - "rawDescription": "The rendering mode.", + "rawDescription": "Description of the gist", "childParamsGroups": [] }, - "context": { - "description": "

The repository context to use when creating references in gfm mode.

", - "type": "string", - "name": "context", + "files": { + "description": "

Names of files to be updated

", + "example": { + "hello.rb": { + "content": "blah", + "filename": "goodbye.rb" + } + }, + "type": "object", + "additionalProperties": { + "type": "object", + "nullable": true, + "properties": { + "content": { + "description": "The new content of the file", + "type": "string" + }, + "filename": { + "description": "The new filename for the file", + "type": "string", + "nullable": true + } + }, + "anyOf": [ + { + "required": [ + "content" + ] + }, + { + "required": [ + "filename" + ] + }, + { + "type": "object", + "maxProperties": 0 + } + ] + }, + "name": "files", "in": "body", - "rawType": "string", - "rawDescription": "The repository context to use when creating references in `gfm` mode.", + "rawType": "object", + "rawDescription": "Names of files to be updated", "childParamsGroups": [] } }, - "required": [ - "text" + "anyOf": [ + { + "required": [ + "description" + ] + }, + { + "required": [ + "files" + ] + } ], - "type": "object" + "type": "object", + "nullable": true } } } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "previews": [], - "category": "markdown", + "category": "gists", "subcategory": null }, - "slug": "render-a-markdown-document", - "category": "markdown", - "categoryLabel": "Markdown", + "slug": "update-a-gist", + "category": "gists", + "categoryLabel": "Gists", "notes": [], + "descriptionHTML": "

Allows you to update or delete a gist file and rename gist files. Files from the previous version of the gist that aren't explicitly changed during an edit are unchanged.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "Response" + "description": "Default response", + "payload": "
{\n  \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n  \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n  \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n  \"id\": \"aa5a315d61ae9438b18d\",\n  \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n  \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n  \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n  \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n  \"created_at\": \"2010-04-14T02:15:15Z\",\n  \"updated_at\": \"2011-06-20T11:34:15Z\",\n  \"description\": \"Hello World Examples\",\n  \"comments\": 0,\n  \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"\n}\n
" }, { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" } ], - "descriptionHTML": "", "bodyParameters": [ { - "description": "

Required. The Markdown text to render in HTML.

", - "type": "string", - "name": "text", - "in": "body", - "rawType": "string", - "rawDescription": "The Markdown text to render in HTML.", - "childParamsGroups": [] - }, - { - "description": "

The rendering mode.

", - "enum": [ - "markdown", - "gfm" - ], - "default": "markdown", - "example": "markdown", + "description": "

Description of the gist

", + "example": "Example Ruby script", "type": "string", - "name": "mode", + "name": "description", "in": "body", "rawType": "string", - "rawDescription": "The rendering mode.", + "rawDescription": "Description of the gist", "childParamsGroups": [] }, { - "description": "

The repository context to use when creating references in gfm mode.

", - "type": "string", - "name": "context", + "description": "

Names of files to be updated

", + "example": { + "hello.rb": { + "content": "blah", + "filename": "goodbye.rb" + } + }, + "type": "object", + "additionalProperties": { + "type": "object", + "nullable": true, + "properties": { + "content": { + "description": "The new content of the file", + "type": "string" + }, + "filename": { + "description": "The new filename for the file", + "type": "string", + "nullable": true + } + }, + "anyOf": [ + { + "required": [ + "content" + ] + }, + { + "required": [ + "filename" + ] + }, + { + "type": "object", + "maxProperties": 0 + } + ] + }, + "name": "files", "in": "body", - "rawType": "string", - "rawDescription": "The repository context to use when creating references in `gfm` mode.", + "rawType": "object", + "rawDescription": "Names of files to be updated", "childParamsGroups": [] } ] }, { - "verb": "post", - "requestPath": "/markdown/raw", + "verb": "delete", + "requestPath": "/gists/{gist_id}", "serverUrl": "https://api.github.com", - "parameters": [], + "parameters": [ + { + "name": "gist_id", + "description": "gist_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

gist_id parameter

" + } + ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown/raw", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/markdown/raw
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /markdown/raw')", - "html": "
await octokit.request('POST /markdown/raw')\n
" + "source": "await octokit.request('DELETE /gists/{gist_id}', {\n gist_id: 'gist_id'\n})", + "html": "
await octokit.request('DELETE /gists/{gist_id}', {\n  gist_id: 'gist_id'\n})\n
" } ], - "summary": "Render a Markdown document in raw mode", - "description": "You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.", - "operationId": "markdown/render-raw", + "summary": "Delete a gist", + "description": "", "tags": [ - "markdown" + "gists" ], + "operationId": "gists/delete", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/markdown/#render-a-markdown-document-in-raw-mode" - }, - "requestBody": { - "content": { - "text/plain": { - "schema": { - "type": "string" - } - }, - "text/x-markdown": { - "schema": { - "type": "string" - } - } - } + "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#delete-a-gist" }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "previews": [], - "category": "markdown", + "category": "gists", "subcategory": null }, - "slug": "render-a-markdown-document-in-raw-mode", - "category": "markdown", - "categoryLabel": "Markdown", + "slug": "delete-a-gist", + "category": "gists", + "categoryLabel": "Gists", "notes": [], "responses": [ { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response" + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" }, { "httpStatusCode": "304", "httpStatusMessage": "Not Modified", "description": "Not modified" - } - ], - "bodyParameters": [], - "descriptionHTML": "

You must send Markdown as plain text (using a Content-Type header of text/plain or text/x-markdown) to this endpoint, rather than using JSON format. In raw mode, GitHub Flavored Markdown is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.

" - }, - { - "verb": "get", - "requestPath": "/meta", - "serverUrl": "https://api.github.com", - "parameters": [], - "x-codeSamples": [ + }, { - "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/meta", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/meta
" + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" }, { - "lang": "JavaScript", - "source": "await octokit.request('GET /meta')", - "html": "
await octokit.request('GET /meta')\n
" + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" } ], - "summary": "Get GitHub AE meta information", - "description": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/).\"\n\n**Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses.", - "tags": [ - "meta" - ], - "operationId": "meta/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/meta/#get-github-meta-information" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "meta", - "subcategory": null - }, - "slug": "get-github-ae-meta-information", - "category": "meta", - "categoryLabel": "Meta", - "notes": [], "bodyParameters": [], - "descriptionHTML": "

Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"

\n

Note: The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses.

", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Default response", - "payload": "
{\n  \"verifiable_password_authentication\": true,\n  \"ssh_key_fingerprints\": {\n    \"SHA256_RSA\": \"nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8\",\n    \"SHA256_DSA\": \"br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ\"\n  },\n  \"hooks\": [\n    \"192.30.252.0/22\"\n  ],\n  \"web\": [\n    \"192.30.252.0/22\",\n    \"185.199.108.0/22\"\n  ],\n  \"api\": [\n    \"192.30.252.0/22\",\n    \"185.199.108.0/22\"\n  ],\n  \"git\": [\n    \"192.30.252.0/22\"\n  ],\n  \"pages\": [\n    \"192.30.252.153/32\",\n    \"192.30.252.154/32\"\n  ],\n  \"importer\": [\n    \"54.158.161.132\",\n    \"54.226.70.38\"\n  ],\n  \"actions\": [\n    \"13.64.0.0/16\",\n    \"13.65.0.0/16\"\n  ]\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - } - ] + "descriptionHTML": "" }, { "verb": "get", - "requestPath": "/networks/{owner}/{repo}/events", + "requestPath": "/gists/{gist_id}/comments", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "repo", + "name": "gist_id", + "description": "gist_id parameter", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "" + "descriptionHTML": "

gist_id parameter

" }, { "name": "per_page", @@ -9469,48 +9395,46 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/networks/octocat/hello-world/events", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/networks/octocat/hello-world/events
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /networks/{owner}/{repo}/events', {\n owner: 'octocat',\n repo: 'hello-world'\n})", - "html": "
await octokit.request('GET /networks/{owner}/{repo}/events', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" + "source": "await octokit.request('GET /gists/{gist_id}/comments', {\n gist_id: 'gist_id'\n})", + "html": "
await octokit.request('GET /gists/{gist_id}/comments', {\n  gist_id: 'gist_id'\n})\n
" } ], - "summary": "List public events for a network of repositories", + "summary": "List gist comments", "description": "", "tags": [ - "activity" + "gists" ], - "operationId": "activity/list-public-events-for-repo-network", + "operationId": "gists/list-comments", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#list-public-events-for-a-network-of-repositories" + "url": "https://docs.github.com/github-ae@latest/rest/reference/gists#list-gist-comments" }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "previews": [], - "category": "activity", - "subcategory": "events" + "category": "gists", + "subcategory": "comments" }, - "slug": "list-public-events-for-a-network-of-repositories", - "category": "activity", - "categoryLabel": "Activity", - "subcategory": "events", - "subcategoryLabel": "Events", + "slug": "list-gist-comments", + "category": "gists", + "categoryLabel": "Gists", + "subcategory": "comments", + "subcategoryLabel": "Comments", "notes": [], + "bodyParameters": [], + "descriptionHTML": "", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "Response" - }, - { - "httpStatusCode": "301", - "httpStatusMessage": "Moved Permanently", - "description": "Moved permanently" + "description": "Default response", + "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDExOkdpc3RDb21tZW50MQ==\",\n    \"url\": \"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\n    \"body\": \"Just commenting for the sake of commenting\",\n    \"user\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"created_at\": \"2011-04-18T23:23:56Z\",\n    \"updated_at\": \"2011-04-18T23:23:56Z\",\n    \"author_association\": \"COLLABORATOR\"\n  }\n]\n
" }, { "httpStatusCode": "304", @@ -9527,397 +9451,389 @@ "httpStatusMessage": "Not Found", "description": "Resource not found" } - ], - "bodyParameters": [], - "descriptionHTML": "" + ] }, { - "verb": "get", - "requestPath": "/notifications", + "verb": "post", + "requestPath": "/gists/{gist_id}/comments", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "all", - "description": "If `true`, show notifications marked as read.", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false - }, - "descriptionHTML": "

If true, show notifications marked as read.

" - }, - { - "name": "participating", - "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", - "in": "query", - "required": false, - "schema": { - "type": "boolean", - "default": false - }, - "descriptionHTML": "

If true, only shows notifications in which the user is directly participating or mentioned.

" - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - }, - "descriptionHTML": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "name": "before", - "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, + "name": "gist_id", + "description": "gist_id parameter", + "in": "path", + "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - }, - "descriptionHTML": "

Results per page (max 100).

" - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - }, - "descriptionHTML": "

Page number of the results to fetch.

" + "descriptionHTML": "

gist_id parameter

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments \\\n  -d '{\"body\":\"body\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /notifications')", - "html": "
await octokit.request('GET /notifications')\n
" + "source": "await octokit.request('POST /gists/{gist_id}/comments', {\n gist_id: 'gist_id',\n body: 'body'\n})", + "html": "
await octokit.request('POST /gists/{gist_id}/comments', {\n  gist_id: 'gist_id',\n  body: 'body'\n})\n
" } ], - "summary": "List notifications for the authenticated user", - "description": "List all notifications for the current user, sorted by most recently updated.", + "summary": "Create a gist comment", + "description": "", "tags": [ - "activity" + "gists" ], - "operationId": "activity/list-notifications-for-authenticated-user", + "operationId": "gists/create-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user" + "url": "https://docs.github.com/github-ae@latest/rest/reference/gists#create-a-gist-comment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "body": { + "description": "

Required. The comment text.

", + "type": "string", + "maxLength": 65535, + "example": "Body of the attachment", + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The comment text.", + "childParamsGroups": [] + } + }, + "type": "object", + "required": [ + "body" + ] + } + } + } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "previews": [], - "category": "activity", - "subcategory": "notifications" + "category": "gists", + "subcategory": "comments" }, - "slug": "list-notifications-for-the-authenticated-user", - "category": "activity", - "categoryLabel": "Activity", - "subcategory": "notifications", - "subcategoryLabel": "Notifications", + "slug": "create-a-gist-comment", + "category": "gists", + "categoryLabel": "Gists", + "subcategory": "comments", + "subcategoryLabel": "Comments", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

List all notifications for the current user, sorted by most recently updated.

", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Default response", - "payload": "
[\n  {\n    \"id\": \"1\",\n    \"repository\": {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World\",\n      \"full_name\": \"octocat/Hello-World\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n      \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n    },\n    \"subject\": {\n      \"title\": \"Greetings\",\n      \"url\": \"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\n      \"latest_comment_url\": \"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\n      \"type\": \"Issue\"\n    },\n    \"reason\": \"subscribed\",\n    \"unread\": true,\n    \"updated_at\": \"2014-11-07T22:01:45Z\",\n    \"last_read_at\": \"2014-11-07T22:01:45Z\",\n    \"url\": \"https://api.github.com/notifications/threads/1\",\n    \"subscription_url\": \"https://api.github.com/notifications/threads/1/subscription\"\n  }\n]\n
" - }, + "descriptionHTML": "", + "bodyParameters": [ + { + "description": "

Required. The comment text.

", + "type": "string", + "maxLength": 65535, + "example": "Body of the attachment", + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The comment text.", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Default response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDExOkdpc3RDb21tZW50MQ==\",\n  \"url\": \"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\n  \"body\": \"Just commenting for the sake of commenting\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2011-04-18T23:23:56Z\",\n  \"updated_at\": \"2011-04-18T23:23:56Z\",\n  \"author_association\": \"COLLABORATOR\"\n}\n
" + }, { "httpStatusCode": "304", "httpStatusMessage": "Not Modified", "description": "Not modified" }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", "description": "Forbidden" }, { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" } ] }, { - "verb": "put", - "requestPath": "/notifications", + "verb": "get", + "requestPath": "/gists/{gist_id}/comments/{comment_id}", "serverUrl": "https://api.github.com", - "parameters": [], + "parameters": [ + { + "name": "gist_id", + "description": "gist_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

gist_id parameter

" + }, + { + "name": "comment_id", + "description": "comment_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

comment_id parameter

" + } + ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /notifications', {\n last_read_at: 'last_read_at'\n})", - "html": "
await octokit.request('PUT /notifications', {\n  last_read_at: 'last_read_at'\n})\n
" + "source": "await octokit.request('GET /gists/{gist_id}/comments/{comment_id}', {\n gist_id: 'gist_id',\n comment_id: 42\n})", + "html": "
await octokit.request('GET /gists/{gist_id}/comments/{comment_id}', {\n  gist_id: 'gist_id',\n  comment_id: 42\n})\n
" } ], - "summary": "Mark notifications as read", - "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub AE](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub AE will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "summary": "Get a gist comment", + "description": "", "tags": [ - "activity" + "gists" ], - "operationId": "activity/mark-notifications-as-read", + "operationId": "gists/get-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#mark-notifications-as-read" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "last_read_at": { - "description": "

Describes the last point that notifications were checked.

", - "type": "string", - "format": "date-time", - "name": "last_read_at", - "in": "body", - "rawType": "string", - "rawDescription": "Describes the last point that notifications were checked.", - "childParamsGroups": [] - }, - "read": { - "description": "

Whether the notification has been read.

", - "type": "boolean", - "name": "read", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the notification has been read.", - "childParamsGroups": [] - } - } - } - } - } + "url": "https://docs.github.com/github-ae@latest/rest/reference/gists#get-a-gist-comment" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "previews": [], - "category": "activity", - "subcategory": "notifications" + "category": "gists", + "subcategory": "comments" }, - "slug": "mark-notifications-as-read", - "category": "activity", - "categoryLabel": "Activity", - "subcategory": "notifications", - "subcategoryLabel": "Notifications", + "slug": "get-a-gist-comment", + "category": "gists", + "categoryLabel": "Gists", + "subcategory": "comments", + "subcategoryLabel": "Comments", "notes": [], + "bodyParameters": [], + "descriptionHTML": "", "responses": [ { - "httpStatusCode": "202", - "httpStatusMessage": "Accepted", - "description": "Response" - }, - { - "httpStatusCode": "205", - "httpStatusMessage": "Reset Content", - "description": "Response" + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDExOkdpc3RDb21tZW50MQ==\",\n  \"url\": \"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\n  \"body\": \"Just commenting for the sake of commenting\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2011-04-18T23:23:56Z\",\n  \"updated_at\": \"2011-04-18T23:23:56Z\",\n  \"author_association\": \"COLLABORATOR\"\n}\n
" }, { "httpStatusCode": "304", "httpStatusMessage": "Not Modified", "description": "Not modified" }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Forbidden" - } - ], - "descriptionHTML": "

Marks all notifications as \"read\" removes it from the default view on GitHub AE. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub AE will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the List notifications for the authenticated user endpoint and pass the query parameter all=false.

", - "bodyParameters": [ - { - "description": "

Describes the last point that notifications were checked.

", - "type": "string", - "format": "date-time", - "name": "last_read_at", - "in": "body", - "rawType": "string", - "rawDescription": "Describes the last point that notifications were checked.", - "childParamsGroups": [] + "description": "Forbidden gist" }, { - "description": "

Whether the notification has been read.

", - "type": "boolean", - "name": "read", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether the notification has been read.", - "childParamsGroups": [] + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" } ] }, { - "verb": "get", - "requestPath": "/notifications/threads/{thread_id}", + "verb": "patch", + "requestPath": "/gists/{gist_id}/comments/{comment_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "thread_id", - "description": "thread_id parameter", + "name": "gist_id", + "description": "gist_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

gist_id parameter

" + }, + { + "name": "comment_id", + "description": "comment_id parameter", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "

thread_id parameter

" + "descriptionHTML": "

comment_id parameter

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42
" + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42 \\\n  -d '{\"body\":\"body\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /notifications/threads/{thread_id}', {\n thread_id: 42\n})", - "html": "
await octokit.request('GET /notifications/threads/{thread_id}', {\n  thread_id: 42\n})\n
" + "source": "await octokit.request('PATCH /gists/{gist_id}/comments/{comment_id}', {\n gist_id: 'gist_id',\n comment_id: 42,\n body: 'body'\n})", + "html": "
await octokit.request('PATCH /gists/{gist_id}/comments/{comment_id}', {\n  gist_id: 'gist_id',\n  comment_id: 42,\n  body: 'body'\n})\n
" } ], - "summary": "Get a thread", + "summary": "Update a gist comment", "description": "", "tags": [ - "activity" + "gists" ], - "operationId": "activity/get-thread", + "operationId": "gists/update-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#get-a-thread" + "url": "https://docs.github.com/github-ae@latest/rest/reference/gists#update-a-gist-comment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "body": { + "description": "

Required. The comment text.

", + "type": "string", + "maxLength": 65535, + "example": "Body of the attachment", + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The comment text.", + "childParamsGroups": [] + } + }, + "type": "object", + "required": [ + "body" + ] + } + } + } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "previews": [], - "category": "activity", - "subcategory": "notifications" + "category": "gists", + "subcategory": "comments" }, - "slug": "get-a-thread", - "category": "activity", - "categoryLabel": "Activity", - "subcategory": "notifications", - "subcategoryLabel": "Notifications", + "slug": "update-a-gist-comment", + "category": "gists", + "categoryLabel": "Gists", + "subcategory": "comments", + "subcategoryLabel": "Comments", "notes": [], - "bodyParameters": [], "descriptionHTML": "", + "bodyParameters": [ + { + "description": "

Required. The comment text.

", + "type": "string", + "maxLength": 65535, + "example": "Body of the attachment", + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The comment text.", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"id\": \"1\",\n  \"repository\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n  },\n  \"subject\": {\n    \"title\": \"Greetings\",\n    \"url\": \"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\n    \"latest_comment_url\": \"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\n    \"type\": \"Issue\"\n  },\n  \"reason\": \"subscribed\",\n  \"unread\": true,\n  \"updated_at\": \"2014-11-07T22:01:45Z\",\n  \"last_read_at\": \"2014-11-07T22:01:45Z\",\n  \"url\": \"https://api.github.com/notifications/threads/1\",\n  \"subscription_url\": \"https://api.github.com/notifications/threads/1/subscription\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDExOkdpc3RDb21tZW50MQ==\",\n  \"url\": \"https://api.github.com/gists/a6db0bec360bb87e9418/comments/1\",\n  \"body\": \"Just commenting for the sake of commenting\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2011-04-18T23:23:56Z\",\n  \"updated_at\": \"2011-04-18T23:23:56Z\",\n  \"author_association\": \"COLLABORATOR\"\n}\n
" }, { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" } ] }, { - "verb": "patch", - "requestPath": "/notifications/threads/{thread_id}", + "verb": "delete", + "requestPath": "/gists/{gist_id}/comments/{comment_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "thread_id", - "description": "thread_id parameter", + "name": "gist_id", + "description": "gist_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

gist_id parameter

" + }, + { + "name": "comment_id", + "description": "comment_id parameter", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "

thread_id parameter

" + "descriptionHTML": "

comment_id parameter

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42", - "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/comments/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/comments/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('PATCH /notifications/threads/{thread_id}', {\n thread_id: 42\n})", - "html": "
await octokit.request('PATCH /notifications/threads/{thread_id}', {\n  thread_id: 42\n})\n
" + "source": "await octokit.request('DELETE /gists/{gist_id}/comments/{comment_id}', {\n gist_id: 'gist_id',\n comment_id: 42\n})", + "html": "
await octokit.request('DELETE /gists/{gist_id}/comments/{comment_id}', {\n  gist_id: 'gist_id',\n  comment_id: 42\n})\n
" } ], - "summary": "Mark a thread as read", + "summary": "Delete a gist comment", "description": "", "tags": [ - "activity" + "gists" ], - "operationId": "activity/mark-thread-as-read", + "operationId": "gists/delete-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#mark-a-thread-as-read" + "url": "https://docs.github.com/github-ae@latest/rest/reference/gists#delete-a-gist-comment" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "previews": [], - "category": "activity", - "subcategory": "notifications" + "category": "gists", + "subcategory": "comments" }, - "slug": "mark-a-thread-as-read", - "category": "activity", - "categoryLabel": "Activity", - "subcategory": "notifications", - "subcategoryLabel": "Notifications", + "slug": "delete-a-gist-comment", + "category": "gists", + "categoryLabel": "Gists", + "subcategory": "comments", + "subcategoryLabel": "Comments", "notes": [], "responses": [ { - "httpStatusCode": "205", - "httpStatusMessage": "Reset Content", - "description": "Response" + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" }, { "httpStatusCode": "304", @@ -9928,6 +9844,11 @@ "httpStatusCode": "403", "httpStatusMessage": "Forbidden", "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" } ], "bodyParameters": [], @@ -9935,246 +9856,328 @@ }, { "verb": "get", - "requestPath": "/notifications/threads/{thread_id}/subscription", + "requestPath": "/gists/{gist_id}/commits", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "thread_id", - "description": "thread_id parameter", + "name": "gist_id", + "description": "gist_id parameter", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" }, - "descriptionHTML": "

thread_id parameter

" + "descriptionHTML": "

gist_id parameter

" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/commits", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/commits
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /notifications/threads/{thread_id}/subscription', {\n thread_id: 42\n})", - "html": "
await octokit.request('GET /notifications/threads/{thread_id}/subscription', {\n  thread_id: 42\n})\n
" + "source": "await octokit.request('GET /gists/{gist_id}/commits', {\n gist_id: 'gist_id'\n})", + "html": "
await octokit.request('GET /gists/{gist_id}/commits', {\n  gist_id: 'gist_id'\n})\n
" } ], - "summary": "Get a thread subscription for the authenticated user", - "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/github-ae@latest/rest/reference/activity#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", + "summary": "List gist commits", + "description": "", "tags": [ - "activity" + "gists" ], - "operationId": "activity/get-thread-subscription-for-authenticated-user", + "operationId": "gists/list-commits", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#get-a-thread-subscription-for-the-authenticated-user" + "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#list-gist-commits" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "previews": [], - "category": "activity", - "subcategory": "notifications" + "category": "gists", + "subcategory": null }, - "slug": "get-a-thread-subscription-for-the-authenticated-user", - "category": "activity", - "categoryLabel": "Activity", - "subcategory": "notifications", - "subcategoryLabel": "Notifications", + "slug": "list-gist-commits", + "category": "gists", + "categoryLabel": "Gists", "notes": [], "bodyParameters": [], - "descriptionHTML": "

This checks to see if the current user is subscribed to a thread. You can also get a repository subscription.

\n

Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were @mentioned, or manually subscribe to a thread.

", + "descriptionHTML": "", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"subscribed\": true,\n  \"ignored\": false,\n  \"reason\": null,\n  \"created_at\": \"2012-10-06T21:34:12Z\",\n  \"url\": \"https://api.github.com/notifications/threads/1/subscription\",\n  \"thread_url\": \"https://api.github.com/notifications/threads/1\"\n}\n
" + "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/57a7f021a713b1c5a6a199b54cc514735d2d462f\",\n    \"version\": \"57a7f021a713b1c5a6a199b54cc514735d2d462f\",\n    \"user\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"change_status\": {\n      \"deletions\": 0,\n      \"additions\": 180,\n      \"total\": 180\n    },\n    \"committed_at\": \"2010-04-14T02:15:15Z\"\n  }\n]\n
" }, { "httpStatusCode": "304", "httpStatusMessage": "Not Modified", "description": "Not modified" }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" } ] }, { - "verb": "put", - "requestPath": "/notifications/threads/{thread_id}/subscription", + "verb": "get", + "requestPath": "/gists/{gist_id}/forks", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "thread_id", - "description": "thread_id parameter", + "name": "gist_id", + "description": "gist_id parameter", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" }, - "descriptionHTML": "

thread_id parameter

" + "descriptionHTML": "

gist_id parameter

" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription \\\n -d '{\"ignored\":true}'", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription \\\n  -d '{\"ignored\":true}'
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/forks
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /notifications/threads/{thread_id}/subscription', {\n thread_id: 42,\n ignored: true\n})", - "html": "
await octokit.request('PUT /notifications/threads/{thread_id}/subscription', {\n  thread_id: 42,\n  ignored: true\n})\n
" + "source": "await octokit.request('GET /gists/{gist_id}/forks', {\n gist_id: 'gist_id'\n})", + "html": "
await octokit.request('GET /gists/{gist_id}/forks', {\n  gist_id: 'gist_id'\n})\n
" } ], - "summary": "Set a thread subscription", - "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/github-ae@latest/rest/reference/activity#delete-a-thread-subscription) endpoint.", + "summary": "List gist forks", + "description": "", "tags": [ - "activity" + "gists" ], - "operationId": "activity/set-thread-subscription", + "operationId": "gists/list-forks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#set-a-thread-subscription" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "ignored": { - "description": "

Whether to block all notifications from a thread.

", - "default": false, - "type": "boolean", - "name": "ignored", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to block all notifications from a thread.", - "childParamsGroups": [] - } - }, - "type": "object" - } - } - } + "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#list-gist-forks" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "previews": [], - "category": "activity", - "subcategory": "notifications" + "category": "gists", + "subcategory": null }, - "slug": "set-a-thread-subscription", - "category": "activity", - "categoryLabel": "Activity", - "subcategory": "notifications", - "subcategoryLabel": "Notifications", + "slug": "list-gist-forks", + "category": "gists", + "categoryLabel": "Gists", "notes": [], - "descriptionHTML": "

If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an @mention.

\n

You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.

\n

Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the Delete a thread subscription endpoint.

", - "bodyParameters": [ - { - "description": "

Whether to block all notifications from a thread.

", - "default": false, - "type": "boolean", - "name": "ignored", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether to block all notifications from a thread.", - "childParamsGroups": [] - } - ], + "bodyParameters": [], + "descriptionHTML": "", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"subscribed\": true,\n  \"ignored\": false,\n  \"reason\": null,\n  \"created_at\": \"2012-10-06T21:34:12Z\",\n  \"url\": \"https://api.github.com/notifications/threads/1/subscription\",\n  \"thread_url\": \"https://api.github.com/notifications/threads/1\"\n}\n
" + "payload": "
[\n  {\n    \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n    \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n    \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n    \"id\": \"aa5a315d61ae9438b18d\",\n    \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n    \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n    \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n    \"files\": {\n      \"hello_world.rb\": {\n        \"filename\": \"hello_world.rb\",\n        \"type\": \"application/x-ruby\",\n        \"language\": \"Ruby\",\n        \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n        \"size\": 167\n      }\n    },\n    \"public\": true,\n    \"created_at\": \"2010-04-14T02:15:15Z\",\n    \"updated_at\": \"2011-06-20T11:34:15Z\",\n    \"description\": \"Hello World Examples\",\n    \"comments\": 1,\n    \"user\": null,\n    \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  }\n]\n
" }, { "httpStatusCode": "304", "httpStatusMessage": "Not Modified", "description": "Not modified" }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", "description": "Forbidden" - } - ] + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + } + ] }, { - "verb": "delete", - "requestPath": "/notifications/threads/{thread_id}/subscription", + "verb": "post", + "requestPath": "/gists/{gist_id}/forks", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "thread_id", - "description": "thread_id parameter", + "name": "gist_id", + "description": "gist_id parameter", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" }, - "descriptionHTML": "

thread_id parameter

" + "descriptionHTML": "

gist_id parameter

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/forks", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/forks
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /notifications/threads/{thread_id}/subscription', {\n thread_id: 42\n})", - "html": "
await octokit.request('DELETE /notifications/threads/{thread_id}/subscription', {\n  thread_id: 42\n})\n
" + "source": "await octokit.request('POST /gists/{gist_id}/forks', {\n gist_id: 'gist_id'\n})", + "html": "
await octokit.request('POST /gists/{gist_id}/forks', {\n  gist_id: 'gist_id'\n})\n
" } ], - "summary": "Delete a thread subscription", - "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/github-ae@latest/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`.", + "summary": "Fork a gist", + "description": "**Note**: This was previously `/gists/:gist_id/fork`.", "tags": [ - "activity" + "gists" ], - "operationId": "activity/delete-thread-subscription", + "operationId": "gists/fork", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#delete-a-thread-subscription" + "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#fork-a-gist" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": false, "previews": [], - "category": "activity", - "subcategory": "notifications" + "category": "gists", + "subcategory": null }, - "slug": "delete-a-thread-subscription", - "category": "activity", - "categoryLabel": "Activity", - "subcategory": "notifications", - "subcategoryLabel": "Notifications", + "slug": "fork-a-gist", + "category": "gists", + "categoryLabel": "Gists", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Note: This was previously /gists/:gist_id/fork.

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Default response", + "payload": "
{\n  \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n  \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n  \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n  \"id\": \"aa5a315d61ae9438b18d\",\n  \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n  \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n  \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n  \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n  \"files\": {\n    \"hello_world.rb\": {\n      \"filename\": \"hello_world.rb\",\n      \"type\": \"application/x-ruby\",\n      \"language\": \"Ruby\",\n      \"raw_url\": \"https://gist.githubusercontent.com/octocat/6cad326836d38bd3a7ae/raw/db9c55113504e46fa076e7df3a04ce592e2e86d8/hello_world.rb\",\n      \"size\": 167\n    }\n  },\n  \"public\": true,\n  \"created_at\": \"2010-04-14T02:15:15Z\",\n  \"updated_at\": \"2011-06-20T11:34:15Z\",\n  \"description\": \"Hello World Examples\",\n  \"comments\": 0,\n  \"user\": null,\n  \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\",\n  \"owner\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"truncated\": false\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, + { + "verb": "get", + "requestPath": "/gists/{gist_id}/star", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "gist_id", + "description": "gist_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

gist_id parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /gists/{gist_id}/star', {\n gist_id: 'gist_id'\n})", + "html": "
await octokit.request('GET /gists/{gist_id}/star', {\n  gist_id: 'gist_id'\n})\n
" + } + ], + "summary": "Check if a gist is starred", + "description": "", + "tags": [ + "gists" + ], + "operationId": "gists/check-is-starred", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#check-if-a-gist-is-starred" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": null + }, + "slug": "check-if-a-gist-is-starred", + "category": "gists", + "categoryLabel": "Gists", "notes": [], "responses": [ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Response if gist is starred" }, { "httpStatusCode": "304", @@ -10182,140 +10185,297 @@ "description": "Not modified" }, { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Response if gist is not starred" + } + ], + "bodyParameters": [], + "descriptionHTML": "" + }, + { + "verb": "put", + "requestPath": "/gists/{gist_id}/star", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "gist_id", + "description": "gist_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

gist_id parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /gists/{gist_id}/star', {\n gist_id: 'gist_id'\n})", + "html": "
await octokit.request('PUT /gists/{gist_id}/star', {\n  gist_id: 'gist_id'\n})\n
" + } + ], + "summary": "Star a gist", + "description": "Note that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "tags": [ + "gists" + ], + "operationId": "gists/star", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#star-a-gist" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "gists", + "subcategory": null + }, + "slug": "star-a-gist", + "category": "gists", + "categoryLabel": "Gists", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" }, { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" } ], "bodyParameters": [], - "descriptionHTML": "

Mutes all future notifications for a conversation until you comment on the thread or get an @mention. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the Set a thread subscription endpoint and set ignore to true.

" + "descriptionHTML": "

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

" }, { - "verb": "get", - "requestPath": "/octocat", + "verb": "delete", + "requestPath": "/gists/{gist_id}/star", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "s", - "in": "query", - "description": "The words to show in Octocat's speech bubble", + "name": "gist_id", + "description": "gist_id parameter", + "in": "path", + "required": true, "schema": { "type": "string" }, - "required": false, - "descriptionHTML": "

The words to show in Octocat's speech bubble

" + "descriptionHTML": "

gist_id parameter

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/octocat", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/octocat
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/star", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/star
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /octocat')", - "html": "
await octokit.request('GET /octocat')\n
" + "source": "await octokit.request('DELETE /gists/{gist_id}/star', {\n gist_id: 'gist_id'\n})", + "html": "
await octokit.request('DELETE /gists/{gist_id}/star', {\n  gist_id: 'gist_id'\n})\n
" } ], - "summary": "Get Octocat", - "description": "Get the octocat as ASCII art", + "summary": "Unstar a gist", + "description": "", "tags": [ - "meta" + "gists" ], - "operationId": "meta/get-octocat", + "operationId": "gists/unstar", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#unstar-a-gist" + }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "previews": [], - "category": "meta" + "category": "gists", + "subcategory": null }, - "slug": "get-octocat", - "category": "meta", - "categoryLabel": "Meta", + "slug": "unstar-a-gist", + "category": "gists", + "categoryLabel": "Gists", "notes": [], "responses": [ { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response" + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" } ], "bodyParameters": [], - "descriptionHTML": "

Get the octocat as ASCII art

" + "descriptionHTML": "" }, { "verb": "get", - "requestPath": "/organizations", + "requestPath": "/gists/{gist_id}/{sha}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "since", - "description": "An organization ID. Only return organizations with an ID greater than this ID.", - "in": "query", - "required": false, + "name": "gist_id", + "description": "gist_id parameter", + "in": "path", + "required": true, "schema": { - "type": "integer" + "type": "string" }, - "descriptionHTML": "

An organization ID. Only return organizations with an ID greater than this ID.

" + "descriptionHTML": "

gist_id parameter

" }, { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", + "name": "sha", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "string" }, - "descriptionHTML": "

Results per page (max 100).

" + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/organizations", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/organizations
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gists/GIST_ID/SHA", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gists/GIST_ID/SHA
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /organizations')", - "html": "
await octokit.request('GET /organizations')\n
" + "source": "await octokit.request('GET /gists/{gist_id}/{sha}', {\n gist_id: 'gist_id',\n sha: 'sha'\n})", + "html": "
await octokit.request('GET /gists/{gist_id}/{sha}', {\n  gist_id: 'gist_id',\n  sha: 'sha'\n})\n
" } ], - "summary": "List organizations", - "description": "Lists all organizations, in the order that they were created on GitHub AE.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations.", + "summary": "Get a gist revision", + "description": "", "tags": [ - "orgs" + "gists" ], - "operationId": "orgs/list", + "operationId": "gists/get-revision", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs/#list-organizations" + "url": "https://docs.github.com/github-ae@latest/rest/reference/gists/#get-a-gist-revision" }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "previews": [], - "category": "orgs", + "category": "gists", "subcategory": null }, - "slug": "list-organizations", - "category": "orgs", - "categoryLabel": "Orgs", + "slug": "get-a-gist-revision", + "category": "gists", + "categoryLabel": "Gists", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Lists all organizations, in the order that they were created on GitHub AE.

\n

Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.

", + "descriptionHTML": "", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  }\n]\n
" + "payload": "
{\n  \"url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d\",\n  \"forks_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/forks\",\n  \"commits_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/commits\",\n  \"id\": \"aa5a315d61ae9438b18d\",\n  \"node_id\": \"MDQ6R2lzdGFhNWEzMTVkNjFhZTk0MzhiMThk\",\n  \"git_pull_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n  \"git_push_url\": \"https://gist.github.com/aa5a315d61ae9438b18d.git\",\n  \"html_url\": \"https://gist.github.com/aa5a315d61ae9438b18d\",\n  \"created_at\": \"2010-04-14T02:15:15Z\",\n  \"updated_at\": \"2011-06-20T11:34:15Z\",\n  \"description\": \"Hello World Examples\",\n  \"comments\": 0,\n  \"comments_url\": \"https://api.github.com/gists/aa5a315d61ae9438b18d/comments/\"\n}\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, + { + "verb": "get", + "requestPath": "/gitignore/templates", + "serverUrl": "https://api.github.com", + "parameters": [], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gitignore/templates
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /gitignore/templates')", + "html": "
await octokit.request('GET /gitignore/templates')\n
" + } + ], + "summary": "Get all gitignore templates", + "description": "List all templates available to pass as an option when [creating a repository](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-for-the-authenticated-user).", + "operationId": "gitignore/get-all-templates", + "tags": [ + "gitignore" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/gitignore/#get-all-gitignore-templates" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "gitignore", + "subcategory": null + }, + "slug": "get-all-gitignore-templates", + "category": "gitignore", + "categoryLabel": "Gitignore", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

List all templates available to pass as an option when creating a repository.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response", + "payload": "
[\n  \"Actionscript\",\n  \"Android\",\n  \"AppceleratorTitanium\",\n  \"Autotools\",\n  \"Bancha\",\n  \"C\",\n  \"C++\"\n]\n
" }, { "httpStatusCode": "304", @@ -10326,11 +10486,11 @@ }, { "verb": "get", - "requestPath": "/orgs/{org}", + "requestPath": "/gitignore/templates/{name}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", + "name": "name", "in": "path", "required": true, "schema": { @@ -10342,308 +10502,7798 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/gitignore/templates/NAME", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/gitignore/templates/NAME
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}', {\n org: 'org'\n})", - "html": "
await octokit.request('GET /orgs/{org}', {\n  org: 'org'\n})\n
" + "source": "await octokit.request('GET /gitignore/templates/{name}', {\n name: 'name'\n})", + "html": "
await octokit.request('GET /gitignore/templates/{name}', {\n  name: 'name'\n})\n
" } ], - "summary": "Get an organization", - "description": "To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nGitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub AE plan. See \"[Authenticating with GitHub Apps](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see 'Response with GitHub AE plan information' below.\"", + "summary": "Get a gitignore template", + "description": "The API also allows fetching the source of a single template.\nUse the raw [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types/) to get the raw contents.", + "operationId": "gitignore/get-template", "tags": [ - "orgs" + "gitignore" ], - "operationId": "orgs/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs/#get-an-organization" + "url": "https://docs.github.com/github-ae@latest/rest/reference/gitignore/#get-a-gitignore-template" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "surtur", - "note": "New repository creation permissions are available to preview. You can now use `members_can_create_public_repositories`, `members_can_create_private_repositories`, and `members_can_create_internal_repositories`. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. These parameters provide more granular permissions to configure the type of repositories organization members can create.\n\nTo access these new parameters during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.surtur-preview+json\n```", - "html": "

New repository creation permissions are available to preview. You can now use members_can_create_public_repositories, members_can_create_private_repositories, and members_can_create_internal_repositories. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. These parameters provide more granular permissions to configure the type of repositories organization members can create.

\n

To access these new parameters during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.surtur-preview+json
" - } - ], - "category": "orgs", + "previews": [], + "category": "gitignore", "subcategory": null }, - "slug": "get-an-organization", - "category": "orgs", - "categoryLabel": "Orgs", + "slug": "get-a-gitignore-template", + "category": "gitignore", + "categoryLabel": "Gitignore", "notes": [], "bodyParameters": [], - "descriptionHTML": "

To see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

\n

GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub AE plan. See \"Authenticating with GitHub Apps\" for details. For an example response, see 'Response with GitHub AE plan information' below.\"

", + "descriptionHTML": "

The API also allows fetching the source of a single template.\nUse the raw media type to get the raw contents.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"total_private_repos\": 100,\n  \"owned_private_repos\": 100,\n  \"private_gists\": 81,\n  \"disk_usage\": 10000,\n  \"collaborators\": 8,\n  \"billing_email\": \"mona@github.com\",\n  \"plan\": {\n    \"name\": \"Medium\",\n    \"space\": 400,\n    \"private_repos\": 20\n  },\n  \"default_repository_permission\": \"read\",\n  \"members_can_create_repositories\": true,\n  \"two_factor_requirement_enabled\": true,\n  \"members_allowed_repository_creation_type\": \"all\",\n  \"members_can_create_public_repositories\": false,\n  \"members_can_create_private_repositories\": false,\n  \"members_can_create_internal_repositories\": false,\n  \"members_can_create_pages\": true\n}\n
" - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response with GitHub plan information", - "payload": "
{\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"plan\": {\n    \"name\": \"team\",\n    \"space\": 976562499,\n    \"private_repos\": 999999,\n    \"filled_seats\": 4,\n    \"seats\": 5\n  }\n}\n
" + "payload": "
{\n  \"name\": \"C\",\n  \"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\"\n}\n
" }, { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" } ] }, { - "verb": "patch", - "requestPath": "/orgs/{org}", + "verb": "get", + "requestPath": "/installation/repositories", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", - "in": "path", - "required": true, + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 30 }, - "descriptionHTML": "" + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG \\\n -d '{\"billing_email\":\"billing_email\"}'", - "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG \\\n  -d '{\"billing_email\":\"billing_email\"}'
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/installation/repositories", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/installation/repositories
" }, { "lang": "JavaScript", - "source": "await octokit.request('PATCH /orgs/{org}', {\n org: 'org',\n billing_email: 'billing_email'\n})", - "html": "
await octokit.request('PATCH /orgs/{org}', {\n  org: 'org',\n  billing_email: 'billing_email'\n})\n
" + "source": "await octokit.request('GET /installation/repositories')", + "html": "
await octokit.request('GET /installation/repositories')\n
" } ], - "summary": "Update an organization", - "description": "**Parameter Deprecation Notice:** GitHub AE will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.", + "summary": "List repositories accessible to the app installation", + "description": "List repositories that an app installation can access.\n\nYou must use an [installation access token](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", "tags": [ - "orgs" + "apps" ], - "operationId": "orgs/update", + "operationId": "apps/list-repos-accessible-to-installation", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs/#update-an-organization" + "url": "https://docs.github.com/github-ae@latest/rest/reference/apps#list-repositories-accessible-to-the-app-installation" }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "billing_email": { - "type": "string", - "description": "

Billing email address. This address is not publicized.

", - "name": "billing_email", - "in": "body", - "rawType": "string", - "rawDescription": "Billing email address. This address is not publicized.", + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "mercy", + "note": "The `topics` property for repositories on GitHub is currently available for developers to preview. To view the `topics` property in calls that return repository results, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.mercy-preview+json\n```", + "html": "

The topics property for repositories on GitHub is currently available for developers to preview. To view the topics property in calls that return repository results, you must provide a custom media type in the Accept header:

\n
application/vnd.github.mercy-preview+json
" + } + ], + "category": "apps", + "subcategory": "installations" + }, + "slug": "list-repositories-accessible-to-the-app-installation", + "category": "apps", + "categoryLabel": "Apps", + "subcategory": "installations", + "subcategoryLabel": "Installations", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

List repositories that an app installation can access.

\n

You must use an installation access token to access this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"total_count\": 1,\n  \"repositories\": [\n    {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World\",\n      \"full_name\": \"octocat/Hello-World\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"allow_rebase_merge\": true,\n      \"template_repository\": null,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://github.com/licenses/mit\"\n      },\n      \"forks\": 1,\n      \"open_issues\": 1,\n      \"watchers\": 1\n    }\n  ]\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + } + ] + }, + { + "verb": "delete", + "requestPath": "/installation/token", + "serverUrl": "https://api.github.com", + "parameters": [], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/installation/token", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/installation/token
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /installation/token')", + "html": "
await octokit.request('DELETE /installation/token')\n
" + } + ], + "summary": "Revoke an installation access token", + "description": "Revokes the installation token you're using to authenticate as an installation and access this endpoint.\n\nOnce an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"[Create an installation access token for an app](https://docs.github.com/github-ae@latest/rest/reference/apps#create-an-installation-access-token-for-an-app)\" endpoint.\n\nYou must use an [installation access token](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-an-installation) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/revoke-installation-access-token", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/apps#revoke-an-installation-access-token" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "apps", + "subcategory": "installations" + }, + "slug": "revoke-an-installation-access-token", + "category": "apps", + "categoryLabel": "Apps", + "subcategory": "installations", + "subcategoryLabel": "Installations", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Revokes the installation token you're using to authenticate as an installation and access this endpoint.

\n

Once an installation token is revoked, the token is invalidated and cannot be used. Other endpoints that require the revoked installation token must have a new installation token to work. You can create a new token using the \"Create an installation access token for an app\" endpoint.

\n

You must use an installation access token to access this endpoint.

" + }, + { + "verb": "get", + "requestPath": "/issues", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "filter", + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "assigned", + "created", + "mentioned", + "subscribed", + "all" + ], + "default": "assigned" + }, + "descriptionHTML": "

Indicates which sorts of issues to return. Can be one of:
\n* assigned: Issues assigned to you
\n* created: Issues created by you
\n* mentioned: Issues mentioning you
\n* subscribed: Issues you're subscribed to updates for
\n* all: All issues the authenticated user can see, regardless of participation or creation

" + }, + { + "name": "state", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + }, + "descriptionHTML": "

Indicates the state of the issues to return. Can be either open, closed, or all.

" + }, + { + "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

A list of comma separated label names. Example: bug,ui,@high

" + }, + { + "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "comments" + ], + "default": "created" + }, + "descriptionHTML": "

What to sort results by. Can be either created, updated, comments.

" + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

One of asc (ascending) or desc (descending).

" + }, + { + "name": "since", + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + }, + { + "name": "collab", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "descriptionHTML": "" + }, + { + "name": "orgs", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "descriptionHTML": "" + }, + { + "name": "owned", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "descriptionHTML": "" + }, + { + "name": "pulls", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "descriptionHTML": "" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/issues", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/issues
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /issues')", + "html": "
await octokit.request('GET /issues')\n
" + } + ], + "summary": "List issues assigned to the authenticated user", + "description": "List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the `filter` query parameter to fetch issues that are not\nnecessarily assigned to you.\n\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests)\" endpoint.", + "tags": [ + "issues" + ], + "operationId": "issues/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/issues/#list-issues-assigned-to-the-authenticated-user" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", + "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + } + ], + "category": "issues", + "subcategory": null + }, + "slug": "list-issues-assigned-to-the-authenticated-user", + "category": "issues", + "categoryLabel": "Issues", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

List issues assigned to the authenticated user across all visible repositories including owned repositories, member\nrepositories, and organization repositories. You can use the filter query parameter to fetch issues that are not\nnecessarily assigned to you.

\n

Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDU6SXNzdWUx\",\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n    \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n    \"number\": 1347,\n    \"state\": \"open\",\n    \"title\": \"Found a bug\",\n    \"body\": \"I'm having a problem with this.\",\n    \"user\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"labels\": [\n      {\n        \"id\": 208045946,\n        \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n        \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n        \"name\": \"bug\",\n        \"description\": \"Something isn't working\",\n        \"color\": \"f29513\",\n        \"default\": true\n      }\n    ],\n    \"assignee\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"assignees\": [\n      {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      }\n    ],\n    \"milestone\": {\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n      \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n      \"id\": 1002604,\n      \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n      \"number\": 1,\n      \"state\": \"open\",\n      \"title\": \"v1.0\",\n      \"description\": \"Tracking milestone for version 1.0\",\n      \"creator\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"open_issues\": 4,\n      \"closed_issues\": 8,\n      \"created_at\": \"2011-04-10T20:09:31Z\",\n      \"updated_at\": \"2014-03-03T18:58:10Z\",\n      \"closed_at\": \"2013-02-12T13:22:01Z\",\n      \"due_on\": \"2012-10-09T23:39:01Z\"\n    },\n    \"locked\": true,\n    \"active_lock_reason\": \"too heated\",\n    \"comments\": 0,\n    \"pull_request\": {\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n      \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n      \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n      \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n    },\n    \"closed_at\": null,\n    \"created_at\": \"2011-04-22T13:33:48Z\",\n    \"updated_at\": \"2011-04-22T13:33:48Z\",\n    \"repository\": {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World\",\n      \"full_name\": \"octocat/Hello-World\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"template_repository\": null,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://github.com/licenses/mit\"\n      },\n      \"forks\": 1,\n      \"open_issues\": 1,\n      \"watchers\": 1\n    },\n    \"author_association\": \"COLLABORATOR\"\n  }\n]\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, + { + "verb": "get", + "requestPath": "/licenses", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "featured", + "in": "query", + "required": false, + "schema": { + "type": "boolean" + }, + "descriptionHTML": "" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/licenses", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/licenses
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /licenses')", + "html": "
await octokit.request('GET /licenses')\n
" + } + ], + "summary": "Get all commonly used licenses", + "description": "", + "tags": [ + "licenses" + ], + "operationId": "licenses/get-all-commonly-used", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/licenses/#get-all-commonly-used-licenses" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "licenses", + "subcategory": null + }, + "slug": "get-all-commonly-used-licenses", + "category": "licenses", + "categoryLabel": "Licenses", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
[\n  {\n    \"key\": \"mit\",\n    \"name\": \"MIT License\",\n    \"spdx_id\": \"MIT\",\n    \"url\": \"https://api.github.com/licenses/mit\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n  },\n  {\n    \"key\": \"lgpl-3.0\",\n    \"name\": \"GNU Lesser General Public License v3.0\",\n    \"spdx_id\": \"LGPL-3.0\",\n    \"url\": \"https://api.github.com/licenses/lgpl-3.0\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n  },\n  {\n    \"key\": \"mpl-2.0\",\n    \"name\": \"Mozilla Public License 2.0\",\n    \"spdx_id\": \"MPL-2.0\",\n    \"url\": \"https://api.github.com/licenses/mpl-2.0\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n  },\n  {\n    \"key\": \"agpl-3.0\",\n    \"name\": \"GNU Affero General Public License v3.0\",\n    \"spdx_id\": \"AGPL-3.0\",\n    \"url\": \"https://api.github.com/licenses/agpl-3.0\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n  },\n  {\n    \"key\": \"unlicense\",\n    \"name\": \"The Unlicense\",\n    \"spdx_id\": \"Unlicense\",\n    \"url\": \"https://api.github.com/licenses/unlicense\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n  },\n  {\n    \"key\": \"apache-2.0\",\n    \"name\": \"Apache License 2.0\",\n    \"spdx_id\": \"Apache-2.0\",\n    \"url\": \"https://api.github.com/licenses/apache-2.0\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n  },\n  {\n    \"key\": \"gpl-3.0\",\n    \"name\": \"GNU General Public License v3.0\",\n    \"spdx_id\": \"GPL-3.0\",\n    \"url\": \"https://api.github.com/licenses/gpl-3.0\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n  }\n]\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + } + ] + }, + { + "verb": "get", + "requestPath": "/licenses/{license}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "license", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/licenses/LICENSE", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/licenses/LICENSE
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /licenses/{license}', {\n license: 'license'\n})", + "html": "
await octokit.request('GET /licenses/{license}', {\n  license: 'license'\n})\n
" + } + ], + "summary": "Get a license", + "description": "", + "tags": [ + "licenses" + ], + "operationId": "licenses/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/licenses/#get-a-license" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "licenses", + "subcategory": null + }, + "slug": "get-a-license", + "category": "licenses", + "categoryLabel": "Licenses", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"key\": \"mit\",\n  \"name\": \"MIT License\",\n  \"spdx_id\": \"MIT\",\n  \"url\": \"https://api.github.com/licenses/mit\",\n  \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n  \"html_url\": \"http://choosealicense.com/licenses/mit/\",\n  \"description\": \"A permissive license that is short and to the point. It lets people do anything with your code with proper attribution and without warranty.\",\n  \"implementation\": \"Create a text file (typically named LICENSE or LICENSE.txt) in the root of your source code and copy the text of the license into the file. Replace [year] with the current year and [fullname] with the name (or names) of the copyright holders.\",\n  \"permissions\": [\n    \"commercial-use\",\n    \"modifications\",\n    \"distribution\",\n    \"sublicense\",\n    \"private-use\"\n  ],\n  \"conditions\": [\n    \"include-copyright\"\n  ],\n  \"limitations\": [\n    \"no-liability\"\n  ],\n  \"body\": \"\\n\\nThe MIT License (MIT)\\n\\nCopyright (c) [year] [fullname]\\n\\nPermission is hereby granted, free of charge, to any person obtaining a copy\\nof this software and associated documentation files (the \\\"Software\\\"), to deal\\nin the Software without restriction, including without limitation the rights\\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\\ncopies of the Software, and to permit persons to whom the Software is\\nfurnished to do so, subject to the following conditions:\\n\\nThe above copyright notice and this permission notice shall be included in all\\ncopies or substantial portions of the Software.\\n\\nTHE SOFTWARE IS PROVIDED \\\"AS IS\\\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\\nSOFTWARE.\\n\",\n  \"featured\": true\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + } + ] + }, + { + "verb": "post", + "requestPath": "/markdown", + "serverUrl": "https://api.github.com", + "parameters": [], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown \\\n -d '{\"text\":\"text\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/markdown \\\n  -d '{\"text\":\"text\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /markdown', {\n text: 'text'\n})", + "html": "
await octokit.request('POST /markdown', {\n  text: 'text'\n})\n
" + } + ], + "summary": "Render a Markdown document", + "description": "", + "operationId": "markdown/render", + "tags": [ + "markdown" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/markdown/#render-a-markdown-document" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "text": { + "description": "

Required. The Markdown text to render in HTML.

", + "type": "string", + "name": "text", + "in": "body", + "rawType": "string", + "rawDescription": "The Markdown text to render in HTML.", "childParamsGroups": [] }, - "company": { + "mode": { + "description": "

The rendering mode.

", + "enum": [ + "markdown", + "gfm" + ], + "default": "markdown", + "example": "markdown", "type": "string", - "description": "

The company name.

", - "name": "company", + "name": "mode", "in": "body", "rawType": "string", - "rawDescription": "The company name.", + "rawDescription": "The rendering mode.", "childParamsGroups": [] }, - "email": { + "context": { + "description": "

The repository context to use when creating references in gfm mode.

", + "type": "string", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The repository context to use when creating references in `gfm` mode.", + "childParamsGroups": [] + } + }, + "required": [ + "text" + ], + "type": "object" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "markdown", + "subcategory": null + }, + "slug": "render-a-markdown-document", + "category": "markdown", + "categoryLabel": "Markdown", + "notes": [], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + } + ], + "descriptionHTML": "", + "bodyParameters": [ + { + "description": "

Required. The Markdown text to render in HTML.

", + "type": "string", + "name": "text", + "in": "body", + "rawType": "string", + "rawDescription": "The Markdown text to render in HTML.", + "childParamsGroups": [] + }, + { + "description": "

The rendering mode.

", + "enum": [ + "markdown", + "gfm" + ], + "default": "markdown", + "example": "markdown", + "type": "string", + "name": "mode", + "in": "body", + "rawType": "string", + "rawDescription": "The rendering mode.", + "childParamsGroups": [] + }, + { + "description": "

The repository context to use when creating references in gfm mode.

", + "type": "string", + "name": "context", + "in": "body", + "rawType": "string", + "rawDescription": "The repository context to use when creating references in `gfm` mode.", + "childParamsGroups": [] + } + ] + }, + { + "verb": "post", + "requestPath": "/markdown/raw", + "serverUrl": "https://api.github.com", + "parameters": [], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/markdown/raw", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/markdown/raw
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /markdown/raw')", + "html": "
await octokit.request('POST /markdown/raw')\n
" + } + ], + "summary": "Render a Markdown document in raw mode", + "description": "You must send Markdown as plain text (using a `Content-Type` header of `text/plain` or `text/x-markdown`) to this endpoint, rather than using JSON format. In raw mode, [GitHub Flavored Markdown](https://github.github.com/gfm/) is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.", + "operationId": "markdown/render-raw", + "tags": [ + "markdown" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/markdown/#render-a-markdown-document-in-raw-mode" + }, + "requestBody": { + "content": { + "text/plain": { + "schema": { + "type": "string" + } + }, + "text/x-markdown": { + "schema": { + "type": "string" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "markdown", + "subcategory": null + }, + "slug": "render-a-markdown-document-in-raw-mode", + "category": "markdown", + "categoryLabel": "Markdown", + "notes": [], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + } + ], + "bodyParameters": [], + "descriptionHTML": "

You must send Markdown as plain text (using a Content-Type header of text/plain or text/x-markdown) to this endpoint, rather than using JSON format. In raw mode, GitHub Flavored Markdown is not supported and Markdown will be rendered in plain format like a README.md file. Markdown content must be 400 KB or less.

" + }, + { + "verb": "get", + "requestPath": "/meta", + "serverUrl": "https://api.github.com", + "parameters": [], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/meta", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/meta
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /meta')", + "html": "
await octokit.request('GET /meta')\n
" + } + ], + "summary": "Get GitHub AE meta information", + "description": "Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"[About GitHub's IP addresses](https://help.github.com/articles/about-github-s-ip-addresses/).\"\n\n**Note:** The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses.", + "tags": [ + "meta" + ], + "operationId": "meta/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/meta/#get-github-meta-information" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "meta", + "subcategory": null + }, + "slug": "get-github-ae-meta-information", + "category": "meta", + "categoryLabel": "Meta", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Returns meta information about GitHub, including a list of GitHub's IP addresses. For more information, see \"About GitHub's IP addresses.\"

\n

Note: The IP addresses shown in the documentation's response are only example values. You must always query the API directly to get the latest list of IP addresses.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"verifiable_password_authentication\": true,\n  \"ssh_key_fingerprints\": {\n    \"SHA256_RSA\": \"nThbg6kXUpJWGl7E1IGOCspRomTxdCARLviKw6E5SY8\",\n    \"SHA256_DSA\": \"br9IjFspm1vxR3iA35FWE+4VTyz1hYVLIE2t1/CeyWQ\"\n  },\n  \"hooks\": [\n    \"192.30.252.0/22\"\n  ],\n  \"web\": [\n    \"192.30.252.0/22\",\n    \"185.199.108.0/22\"\n  ],\n  \"api\": [\n    \"192.30.252.0/22\",\n    \"185.199.108.0/22\"\n  ],\n  \"git\": [\n    \"192.30.252.0/22\"\n  ],\n  \"pages\": [\n    \"192.30.252.153/32\",\n    \"192.30.252.154/32\"\n  ],\n  \"importer\": [\n    \"54.158.161.132\",\n    \"54.226.70.38\"\n  ],\n  \"actions\": [\n    \"13.64.0.0/16\",\n    \"13.65.0.0/16\"\n  ]\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + } + ] + }, + { + "verb": "get", + "requestPath": "/networks/{owner}/{repo}/events", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/networks/octocat/hello-world/events", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/networks/octocat/hello-world/events
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /networks/{owner}/{repo}/events', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
await octokit.request('GET /networks/{owner}/{repo}/events', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" + } + ], + "summary": "List public events for a network of repositories", + "description": "", + "tags": [ + "activity" + ], + "operationId": "activity/list-public-events-for-repo-network", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#list-public-events-for-a-network-of-repositories" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "activity", + "subcategory": "events" + }, + "slug": "list-public-events-for-a-network-of-repositories", + "category": "activity", + "categoryLabel": "Activity", + "subcategory": "events", + "subcategoryLabel": "Events", + "notes": [], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response" + }, + { + "httpStatusCode": "301", + "httpStatusMessage": "Moved Permanently", + "description": "Moved permanently" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + } + ], + "bodyParameters": [], + "descriptionHTML": "" + }, + { + "verb": "get", + "requestPath": "/notifications", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "all", + "description": "If `true`, show notifications marked as read.", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "descriptionHTML": "

If true, show notifications marked as read.

" + }, + { + "name": "participating", + "description": "If `true`, only shows notifications in which the user is directly participating or mentioned.", + "in": "query", + "required": false, + "schema": { + "type": "boolean", + "default": false + }, + "descriptionHTML": "

If true, only shows notifications in which the user is directly participating or mentioned.

" + }, + { + "name": "since", + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + }, + { + "name": "before", + "description": "Only show notifications updated before the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

Only show notifications updated before the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /notifications')", + "html": "
await octokit.request('GET /notifications')\n
" + } + ], + "summary": "List notifications for the authenticated user", + "description": "List all notifications for the current user, sorted by most recently updated.", + "tags": [ + "activity" + ], + "operationId": "activity/list-notifications-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "notifications" + }, + "slug": "list-notifications-for-the-authenticated-user", + "category": "activity", + "categoryLabel": "Activity", + "subcategory": "notifications", + "subcategoryLabel": "Notifications", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

List all notifications for the current user, sorted by most recently updated.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
[\n  {\n    \"id\": \"1\",\n    \"repository\": {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World\",\n      \"full_name\": \"octocat/Hello-World\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n      \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n    },\n    \"subject\": {\n      \"title\": \"Greetings\",\n      \"url\": \"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\n      \"latest_comment_url\": \"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\n      \"type\": \"Issue\"\n    },\n    \"reason\": \"subscribed\",\n    \"unread\": true,\n    \"updated_at\": \"2014-11-07T22:01:45Z\",\n    \"last_read_at\": \"2014-11-07T22:01:45Z\",\n    \"url\": \"https://api.github.com/notifications/threads/1\",\n    \"subscription_url\": \"https://api.github.com/notifications/threads/1/subscription\"\n  }\n]\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, + { + "verb": "put", + "requestPath": "/notifications", + "serverUrl": "https://api.github.com", + "parameters": [], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications \\\n -d '{\"last_read_at\":\"last_read_at\"}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications \\\n  -d '{\"last_read_at\":\"last_read_at\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /notifications', {\n last_read_at: 'last_read_at'\n})", + "html": "
await octokit.request('PUT /notifications', {\n  last_read_at: 'last_read_at'\n})\n
" + } + ], + "summary": "Mark notifications as read", + "description": "Marks all notifications as \"read\" removes it from the [default view on GitHub AE](https://github.com/notifications). If the number of notifications is too large to complete in one request, you will receive a `202 Accepted` status and GitHub AE will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the [List notifications for the authenticated user](https://docs.github.com/github-ae@latest/rest/reference/activity#list-notifications-for-the-authenticated-user) endpoint and pass the query parameter `all=false`.", + "tags": [ + "activity" + ], + "operationId": "activity/mark-notifications-as-read", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#mark-notifications-as-read" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "last_read_at": { + "description": "

Describes the last point that notifications were checked.

", + "type": "string", + "format": "date-time", + "name": "last_read_at", + "in": "body", + "rawType": "string", + "rawDescription": "Describes the last point that notifications were checked.", + "childParamsGroups": [] + }, + "read": { + "description": "

Whether the notification has been read.

", + "type": "boolean", + "name": "read", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether the notification has been read.", + "childParamsGroups": [] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "notifications" + }, + "slug": "mark-notifications-as-read", + "category": "activity", + "categoryLabel": "Activity", + "subcategory": "notifications", + "subcategoryLabel": "Notifications", + "notes": [], + "responses": [ + { + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Response" + }, + { + "httpStatusCode": "205", + "httpStatusMessage": "Reset Content", + "description": "Response" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + } + ], + "descriptionHTML": "

Marks all notifications as \"read\" removes it from the default view on GitHub AE. If the number of notifications is too large to complete in one request, you will receive a 202 Accepted status and GitHub AE will run an asynchronous process to mark notifications as \"read.\" To check whether any \"unread\" notifications remain, you can use the List notifications for the authenticated user endpoint and pass the query parameter all=false.

", + "bodyParameters": [ + { + "description": "

Describes the last point that notifications were checked.

", + "type": "string", + "format": "date-time", + "name": "last_read_at", + "in": "body", + "rawType": "string", + "rawDescription": "Describes the last point that notifications were checked.", + "childParamsGroups": [] + }, + { + "description": "

Whether the notification has been read.

", + "type": "boolean", + "name": "read", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether the notification has been read.", + "childParamsGroups": [] + } + ] + }, + { + "verb": "get", + "requestPath": "/notifications/threads/{thread_id}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "thread_id", + "description": "thread_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

thread_id parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /notifications/threads/{thread_id}', {\n thread_id: 42\n})", + "html": "
await octokit.request('GET /notifications/threads/{thread_id}', {\n  thread_id: 42\n})\n
" + } + ], + "summary": "Get a thread", + "description": "", + "tags": [ + "activity" + ], + "operationId": "activity/get-thread", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#get-a-thread" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "notifications" + }, + "slug": "get-a-thread", + "category": "activity", + "categoryLabel": "Activity", + "subcategory": "notifications", + "subcategoryLabel": "Notifications", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"id\": \"1\",\n  \"repository\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n  },\n  \"subject\": {\n    \"title\": \"Greetings\",\n    \"url\": \"https://api.github.com/repos/octokit/octokit.rb/issues/123\",\n    \"latest_comment_url\": \"https://api.github.com/repos/octokit/octokit.rb/issues/comments/123\",\n    \"type\": \"Issue\"\n  },\n  \"reason\": \"subscribed\",\n  \"unread\": true,\n  \"updated_at\": \"2014-11-07T22:01:45Z\",\n  \"last_read_at\": \"2014-11-07T22:01:45Z\",\n  \"url\": \"https://api.github.com/notifications/threads/1\",\n  \"subscription_url\": \"https://api.github.com/notifications/threads/1/subscription\"\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + } + ] + }, + { + "verb": "patch", + "requestPath": "/notifications/threads/{thread_id}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "thread_id", + "description": "thread_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

thread_id parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42", + "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PATCH /notifications/threads/{thread_id}', {\n thread_id: 42\n})", + "html": "
await octokit.request('PATCH /notifications/threads/{thread_id}', {\n  thread_id: 42\n})\n
" + } + ], + "summary": "Mark a thread as read", + "description": "", + "tags": [ + "activity" + ], + "operationId": "activity/mark-thread-as-read", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#mark-a-thread-as-read" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "notifications" + }, + "slug": "mark-a-thread-as-read", + "category": "activity", + "categoryLabel": "Activity", + "subcategory": "notifications", + "subcategoryLabel": "Notifications", + "notes": [], + "responses": [ + { + "httpStatusCode": "205", + "httpStatusMessage": "Reset Content", + "description": "Response" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + } + ], + "bodyParameters": [], + "descriptionHTML": "" + }, + { + "verb": "get", + "requestPath": "/notifications/threads/{thread_id}/subscription", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "thread_id", + "description": "thread_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

thread_id parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /notifications/threads/{thread_id}/subscription', {\n thread_id: 42\n})", + "html": "
await octokit.request('GET /notifications/threads/{thread_id}/subscription', {\n  thread_id: 42\n})\n
" + } + ], + "summary": "Get a thread subscription for the authenticated user", + "description": "This checks to see if the current user is subscribed to a thread. You can also [get a repository subscription](https://docs.github.com/github-ae@latest/rest/reference/activity#get-a-repository-subscription).\n\nNote that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were **@mentioned**, or manually subscribe to a thread.", + "tags": [ + "activity" + ], + "operationId": "activity/get-thread-subscription-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#get-a-thread-subscription-for-the-authenticated-user" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "notifications" + }, + "slug": "get-a-thread-subscription-for-the-authenticated-user", + "category": "activity", + "categoryLabel": "Activity", + "subcategory": "notifications", + "subcategoryLabel": "Notifications", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

This checks to see if the current user is subscribed to a thread. You can also get a repository subscription.

\n

Note that subscriptions are only generated if a user is participating in a conversation--for example, they've replied to the thread, were @mentioned, or manually subscribe to a thread.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"subscribed\": true,\n  \"ignored\": false,\n  \"reason\": null,\n  \"created_at\": \"2012-10-06T21:34:12Z\",\n  \"url\": \"https://api.github.com/notifications/threads/1/subscription\",\n  \"thread_url\": \"https://api.github.com/notifications/threads/1\"\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + } + ] + }, + { + "verb": "put", + "requestPath": "/notifications/threads/{thread_id}/subscription", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "thread_id", + "description": "thread_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

thread_id parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription \\\n -d '{\"ignored\":true}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription \\\n  -d '{\"ignored\":true}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /notifications/threads/{thread_id}/subscription', {\n thread_id: 42,\n ignored: true\n})", + "html": "
await octokit.request('PUT /notifications/threads/{thread_id}/subscription', {\n  thread_id: 42,\n  ignored: true\n})\n
" + } + ], + "summary": "Set a thread subscription", + "description": "If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an **@mention**.\n\nYou can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.\n\nUnsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the [Delete a thread subscription](https://docs.github.com/github-ae@latest/rest/reference/activity#delete-a-thread-subscription) endpoint.", + "tags": [ + "activity" + ], + "operationId": "activity/set-thread-subscription", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#set-a-thread-subscription" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "ignored": { + "description": "

Whether to block all notifications from a thread.

", + "default": false, + "type": "boolean", + "name": "ignored", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether to block all notifications from a thread.", + "childParamsGroups": [] + } + }, + "type": "object" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "notifications" + }, + "slug": "set-a-thread-subscription", + "category": "activity", + "categoryLabel": "Activity", + "subcategory": "notifications", + "subcategoryLabel": "Notifications", + "notes": [], + "descriptionHTML": "

If you are watching a repository, you receive notifications for all threads by default. Use this endpoint to ignore future notifications for threads until you comment on the thread or get an @mention.

\n

You can also use this endpoint to subscribe to threads that you are currently not receiving notifications for or to subscribed to threads that you have previously ignored.

\n

Unsubscribing from a conversation in a repository that you are not watching is functionally equivalent to the Delete a thread subscription endpoint.

", + "bodyParameters": [ + { + "description": "

Whether to block all notifications from a thread.

", + "default": false, + "type": "boolean", + "name": "ignored", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether to block all notifications from a thread.", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"subscribed\": true,\n  \"ignored\": false,\n  \"reason\": null,\n  \"created_at\": \"2012-10-06T21:34:12Z\",\n  \"url\": \"https://api.github.com/notifications/threads/1/subscription\",\n  \"thread_url\": \"https://api.github.com/notifications/threads/1\"\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + } + ] + }, + { + "verb": "delete", + "requestPath": "/notifications/threads/{thread_id}/subscription", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "thread_id", + "description": "thread_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

thread_id parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/notifications/threads/42/subscription", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/notifications/threads/42/subscription
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /notifications/threads/{thread_id}/subscription', {\n thread_id: 42\n})", + "html": "
await octokit.request('DELETE /notifications/threads/{thread_id}/subscription', {\n  thread_id: 42\n})\n
" + } + ], + "summary": "Delete a thread subscription", + "description": "Mutes all future notifications for a conversation until you comment on the thread or get an **@mention**. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the [Set a thread subscription](https://docs.github.com/github-ae@latest/rest/reference/activity#set-a-thread-subscription) endpoint and set `ignore` to `true`.", + "tags": [ + "activity" + ], + "operationId": "activity/delete-thread-subscription", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#delete-a-thread-subscription" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "activity", + "subcategory": "notifications" + }, + "slug": "delete-a-thread-subscription", + "category": "activity", + "categoryLabel": "Activity", + "subcategory": "notifications", + "subcategoryLabel": "Notifications", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Mutes all future notifications for a conversation until you comment on the thread or get an @mention. If you are watching the repository of the thread, you will still receive notifications. To ignore future notifications for a repository you are watching, use the Set a thread subscription endpoint and set ignore to true.

" + }, + { + "verb": "get", + "requestPath": "/octocat", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "s", + "in": "query", + "description": "The words to show in Octocat's speech bubble", + "schema": { + "type": "string" + }, + "required": false, + "descriptionHTML": "

The words to show in Octocat's speech bubble

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/octocat", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/octocat
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /octocat')", + "html": "
await octokit.request('GET /octocat')\n
" + } + ], + "summary": "Get Octocat", + "description": "Get the octocat as ASCII art", + "tags": [ + "meta" + ], + "operationId": "meta/get-octocat", + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "meta" + }, + "slug": "get-octocat", + "category": "meta", + "categoryLabel": "Meta", + "notes": [], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Get the octocat as ASCII art

" + }, + { + "verb": "get", + "requestPath": "/organizations", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "since", + "description": "An organization ID. Only return organizations with an ID greater than this ID.", + "in": "query", + "required": false, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

An organization ID. Only return organizations with an ID greater than this ID.

" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/organizations", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/organizations
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /organizations')", + "html": "
await octokit.request('GET /organizations')\n
" + } + ], + "summary": "List organizations", + "description": "Lists all organizations, in the order that they were created on GitHub AE.\n\n**Note:** Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of organizations.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs/#list-organizations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": null + }, + "slug": "list-organizations", + "category": "orgs", + "categoryLabel": "Orgs", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Lists all organizations, in the order that they were created on GitHub AE.

\n

Note: Pagination is powered exclusively by the since parameter. Use the Link header to get the URL for the next page of organizations.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
[\n  {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  }\n]\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + } + ] + }, + { + "verb": "get", + "requestPath": "/orgs/{org}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}', {\n org: 'org'\n})", + "html": "
await octokit.request('GET /orgs/{org}', {\n  org: 'org'\n})\n
" + } + ], + "summary": "Get an organization", + "description": "To see many of the organization response values, you need to be an authenticated organization owner with the `admin:org` scope. When the value of `two_factor_requirement_enabled` is `true`, the organization requires all members, billing managers, and outside collaborators to enable [two-factor authentication](https://help.github.com/articles/securing-your-account-with-two-factor-authentication-2fa/).\n\nGitHub Apps with the `Organization plan` permission can use this endpoint to retrieve information about an organization's GitHub AE plan. See \"[Authenticating with GitHub Apps](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/)\" for details. For an example response, see 'Response with GitHub AE plan information' below.\"", + "tags": [ + "orgs" + ], + "operationId": "orgs/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs/#get-an-organization" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "surtur", + "note": "New repository creation permissions are available to preview. You can now use `members_can_create_public_repositories`, `members_can_create_private_repositories`, and `members_can_create_internal_repositories`. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. These parameters provide more granular permissions to configure the type of repositories organization members can create.\n\nTo access these new parameters during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.surtur-preview+json\n```", + "html": "

New repository creation permissions are available to preview. You can now use members_can_create_public_repositories, members_can_create_private_repositories, and members_can_create_internal_repositories. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. These parameters provide more granular permissions to configure the type of repositories organization members can create.

\n

To access these new parameters during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.surtur-preview+json
" + } + ], + "category": "orgs", + "subcategory": null + }, + "slug": "get-an-organization", + "category": "orgs", + "categoryLabel": "Orgs", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

To see many of the organization response values, you need to be an authenticated organization owner with the admin:org scope. When the value of two_factor_requirement_enabled is true, the organization requires all members, billing managers, and outside collaborators to enable two-factor authentication.

\n

GitHub Apps with the Organization plan permission can use this endpoint to retrieve information about an organization's GitHub AE plan. See \"Authenticating with GitHub Apps\" for details. For an example response, see 'Response with GitHub AE plan information' below.\"

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"total_private_repos\": 100,\n  \"owned_private_repos\": 100,\n  \"private_gists\": 81,\n  \"disk_usage\": 10000,\n  \"collaborators\": 8,\n  \"billing_email\": \"mona@github.com\",\n  \"plan\": {\n    \"name\": \"Medium\",\n    \"space\": 400,\n    \"private_repos\": 20\n  },\n  \"default_repository_permission\": \"read\",\n  \"members_can_create_repositories\": true,\n  \"two_factor_requirement_enabled\": true,\n  \"members_allowed_repository_creation_type\": \"all\",\n  \"members_can_create_public_repositories\": false,\n  \"members_can_create_private_repositories\": false,\n  \"members_can_create_internal_repositories\": false,\n  \"members_can_create_pages\": true\n}\n
" + }, + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response with GitHub plan information", + "payload": "
{\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\",\n  \"type\": \"Organization\",\n  \"plan\": {\n    \"name\": \"team\",\n    \"space\": 976562499,\n    \"private_repos\": 999999,\n    \"filled_seats\": 4,\n    \"seats\": 5\n  }\n}\n
" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + } + ] + }, + { + "verb": "patch", + "requestPath": "/orgs/{org}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG \\\n -d '{\"billing_email\":\"billing_email\"}'", + "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG \\\n  -d '{\"billing_email\":\"billing_email\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PATCH /orgs/{org}', {\n org: 'org',\n billing_email: 'billing_email'\n})", + "html": "
await octokit.request('PATCH /orgs/{org}', {\n  org: 'org',\n  billing_email: 'billing_email'\n})\n
" + } + ], + "summary": "Update an organization", + "description": "**Parameter Deprecation Notice:** GitHub AE will replace and discontinue `members_allowed_repository_creation_type` in favor of more granular permissions. The new input parameters are `members_can_create_public_repositories`, `members_can_create_private_repositories` for all organizations and `members_can_create_internal_repositories` for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes).\n\nEnables an authenticated organization owner with the `admin:org` scope to update the organization's profile and member privileges.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs/#update-an-organization" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "billing_email": { + "type": "string", + "description": "

Billing email address. This address is not publicized.

", + "name": "billing_email", + "in": "body", + "rawType": "string", + "rawDescription": "Billing email address. This address is not publicized.", + "childParamsGroups": [] + }, + "company": { + "type": "string", + "description": "

The company name.

", + "name": "company", + "in": "body", + "rawType": "string", + "rawDescription": "The company name.", + "childParamsGroups": [] + }, + "email": { + "type": "string", + "description": "

The publicly visible email address.

", + "name": "email", + "in": "body", + "rawType": "string", + "rawDescription": "The publicly visible email address.", + "childParamsGroups": [] + }, + "twitter_username": { + "type": "string", + "description": "

The Twitter username of the company.

", + "name": "twitter_username", + "in": "body", + "rawType": "string", + "rawDescription": "The Twitter username of the company.", + "childParamsGroups": [] + }, + "location": { + "type": "string", + "description": "

The location.

", + "name": "location", + "in": "body", + "rawType": "string", + "rawDescription": "The location.", + "childParamsGroups": [] + }, + "name": { + "type": "string", + "description": "

The shorthand name of the company.

", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "The shorthand name of the company.", + "childParamsGroups": [] + }, + "description": { + "type": "string", + "description": "

The description of the company.

", + "name": "description", + "in": "body", + "rawType": "string", + "rawDescription": "The description of the company.", + "childParamsGroups": [] + }, + "has_organization_projects": { + "type": "boolean", + "description": "

Toggles whether an organization can use organization projects.

", + "name": "has_organization_projects", + "in": "body", + "rawType": "boolean", + "rawDescription": "Toggles whether an organization can use organization projects.", + "childParamsGroups": [] + }, + "has_repository_projects": { + "type": "boolean", + "description": "

Toggles whether repositories that belong to the organization can use repository projects.

", + "name": "has_repository_projects", + "in": "body", + "rawType": "boolean", + "rawDescription": "Toggles whether repositories that belong to the organization can use repository projects.", + "childParamsGroups": [] + }, + "default_repository_permission": { + "type": "string", + "description": "

Default permission level members have for organization repositories:
\n* read - can pull, but not push to or administer this repository.
\n* write - can pull and push, but not administer this repository.
\n* admin - can pull, push, and administer this repository.
\n* none - no permissions granted by default.

", + "enum": [ + "read", + "write", + "admin", + "none" + ], + "default": "read", + "name": "default_repository_permission", + "in": "body", + "rawType": "string", + "rawDescription": "Default permission level members have for organization repositories: \n\\* `read` - can pull, but not push to or administer this repository. \n\\* `write` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push, and administer this repository. \n\\* `none` - no permissions granted by default.", + "childParamsGroups": [] + }, + "members_can_create_repositories": { + "type": "boolean", + "description": "

Toggles the ability of non-admin organization members to create repositories. Can be one of:
\n* true - all organization members can create repositories.
\n* false - only organization owners can create repositories.
\nDefault: true
\nNote: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

", + "default": true, + "name": "members_can_create_repositories", + "in": "body", + "rawType": "boolean", + "rawDescription": "Toggles the ability of non-admin organization members to create repositories. Can be one of: \n\\* `true` - all organization members can create repositories. \n\\* `false` - only organization owners can create repositories. \nDefault: `true` \n**Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", + "childParamsGroups": [] + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "description": "

Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of:
\n* true - all organization members can create internal repositories.
\n* false - only organization owners can create internal repositories.
\nDefault: true. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", + "name": "members_can_create_internal_repositories", + "in": "body", + "rawType": "boolean", + "rawDescription": "Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: \n\\* `true` - all organization members can create internal repositories. \n\\* `false` - only organization owners can create internal repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "childParamsGroups": [] + }, + "members_can_create_private_repositories": { + "type": "boolean", + "description": "

Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of:
\n* true - all organization members can create private repositories.
\n* false - only organization owners can create private repositories.
\nDefault: true. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", + "name": "members_can_create_private_repositories", + "in": "body", + "rawType": "boolean", + "rawDescription": "Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: \n\\* `true` - all organization members can create private repositories. \n\\* `false` - only organization owners can create private repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "childParamsGroups": [] + }, + "members_can_create_public_repositories": { + "type": "boolean", + "description": "

Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of:
\n* true - all organization members can create public repositories.
\n* false - only organization owners can create public repositories.
\nDefault: true. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", + "name": "members_can_create_public_repositories", + "in": "body", + "rawType": "boolean", + "rawDescription": "Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: \n\\* `true` - all organization members can create public repositories. \n\\* `false` - only organization owners can create public repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "childParamsGroups": [] + }, + "members_allowed_repository_creation_type": { + "type": "string", + "description": "

Specifies which types of repositories non-admin organization members can create. Can be one of:
\n* all - all organization members can create public and private repositories.
\n* private - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud.
\n* none - only admin members can create repositories.
\nNote: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See the parameter deprecation notice in the operation description for details.

", + "enum": [ + "all", + "private", + "none" + ], + "name": "members_allowed_repository_creation_type", + "in": "body", + "rawType": "string", + "rawDescription": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n\\* `none` - only admin members can create repositories. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", + "childParamsGroups": [] + }, + "members_can_create_pages": { + "type": "boolean", + "description": "

Toggles whether organization members can create GitHub Pages sites. Can be one of:
\n* true - all organization members can create GitHub Pages sites.
\n* false - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.

", + "default": true, + "name": "members_can_create_pages", + "in": "body", + "rawType": "boolean", + "rawDescription": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.", + "childParamsGroups": [] + }, + "members_can_create_public_pages": { + "type": "boolean", + "description": "

Toggles whether organization members can create public GitHub Pages sites. Can be one of:
\n* true - all organization members can create public GitHub Pages sites.
\n* false - no organization members can create public GitHub Pages sites. Existing published sites will not be impacted.

", + "default": true, + "name": "members_can_create_public_pages", + "in": "body", + "rawType": "boolean", + "rawDescription": "Toggles whether organization members can create public GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create public GitHub Pages sites. \n\\* `false` - no organization members can create public GitHub Pages sites. Existing published sites will not be impacted.", + "childParamsGroups": [] + }, + "members_can_create_private_pages": { + "type": "boolean", + "description": "

Toggles whether organization members can create private GitHub Pages sites. Can be one of:
\n* true - all organization members can create private GitHub Pages sites.
\n* false - no organization members can create private GitHub Pages sites. Existing published sites will not be impacted.

", + "default": true, + "name": "members_can_create_private_pages", + "in": "body", + "rawType": "boolean", + "rawDescription": "Toggles whether organization members can create private GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create private GitHub Pages sites. \n\\* `false` - no organization members can create private GitHub Pages sites. Existing published sites will not be impacted.", + "childParamsGroups": [] + }, + "blog": { + "type": "string", + "example": "\"http://github.blog\"", + "name": "blog", + "in": "body", + "rawType": "string", + "description": "

undefined

", + "childParamsGroups": [] + } + } + }, + "example": { + "billing_email": "mona@github.com", + "company": "GitHub", + "email": "mona@github.com", + "twitter_username": "github", + "location": "San Francisco", + "name": "github", + "description": "GitHub, the company.", + "default_repository_permission": "read", + "members_can_create_repositories": true, + "members_allowed_repository_creation_type": "all" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "surtur", + "note": "New repository creation permissions are available to preview. You can now use `members_can_create_public_repositories`, `members_can_create_private_repositories`, and `members_can_create_internal_repositories`. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. These parameters provide more granular permissions to configure the type of repositories organization members can create.\n\nTo access these new parameters during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.surtur-preview+json\n```", + "html": "

New repository creation permissions are available to preview. You can now use members_can_create_public_repositories, members_can_create_private_repositories, and members_can_create_internal_repositories. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. These parameters provide more granular permissions to configure the type of repositories organization members can create.

\n

To access these new parameters during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.surtur-preview+json
" + } + ], + "category": "orgs", + "subcategory": null + }, + "slug": "update-an-organization", + "category": "orgs", + "categoryLabel": "Orgs", + "notes": [], + "descriptionHTML": "

Parameter Deprecation Notice: GitHub AE will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

\n

Enables an authenticated organization owner with the admin:org scope to update the organization's profile and member privileges.

", + "bodyParameters": [ + { + "type": "string", + "description": "

Billing email address. This address is not publicized.

", + "name": "billing_email", + "in": "body", + "rawType": "string", + "rawDescription": "Billing email address. This address is not publicized.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The company name.

", + "name": "company", + "in": "body", + "rawType": "string", + "rawDescription": "The company name.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The publicly visible email address.

", + "name": "email", + "in": "body", + "rawType": "string", + "rawDescription": "The publicly visible email address.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The Twitter username of the company.

", + "name": "twitter_username", + "in": "body", + "rawType": "string", + "rawDescription": "The Twitter username of the company.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The location.

", + "name": "location", + "in": "body", + "rawType": "string", + "rawDescription": "The location.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The shorthand name of the company.

", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "The shorthand name of the company.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The description of the company.

", + "name": "description", + "in": "body", + "rawType": "string", + "rawDescription": "The description of the company.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Toggles whether an organization can use organization projects.

", + "name": "has_organization_projects", + "in": "body", + "rawType": "boolean", + "rawDescription": "Toggles whether an organization can use organization projects.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Toggles whether repositories that belong to the organization can use repository projects.

", + "name": "has_repository_projects", + "in": "body", + "rawType": "boolean", + "rawDescription": "Toggles whether repositories that belong to the organization can use repository projects.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

Default permission level members have for organization repositories:
\n* read - can pull, but not push to or administer this repository.
\n* write - can pull and push, but not administer this repository.
\n* admin - can pull, push, and administer this repository.
\n* none - no permissions granted by default.

", + "enum": [ + "read", + "write", + "admin", + "none" + ], + "default": "read", + "name": "default_repository_permission", + "in": "body", + "rawType": "string", + "rawDescription": "Default permission level members have for organization repositories: \n\\* `read` - can pull, but not push to or administer this repository. \n\\* `write` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push, and administer this repository. \n\\* `none` - no permissions granted by default.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Toggles the ability of non-admin organization members to create repositories. Can be one of:
\n* true - all organization members can create repositories.
\n* false - only organization owners can create repositories.
\nDefault: true
\nNote: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

", + "default": true, + "name": "members_can_create_repositories", + "in": "body", + "rawType": "boolean", + "rawDescription": "Toggles the ability of non-admin organization members to create repositories. Can be one of: \n\\* `true` - all organization members can create repositories. \n\\* `false` - only organization owners can create repositories. \nDefault: `true` \n**Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of:
\n* true - all organization members can create internal repositories.
\n* false - only organization owners can create internal repositories.
\nDefault: true. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", + "name": "members_can_create_internal_repositories", + "in": "body", + "rawType": "boolean", + "rawDescription": "Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: \n\\* `true` - all organization members can create internal repositories. \n\\* `false` - only organization owners can create internal repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of:
\n* true - all organization members can create private repositories.
\n* false - only organization owners can create private repositories.
\nDefault: true. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", + "name": "members_can_create_private_repositories", + "in": "body", + "rawType": "boolean", + "rawDescription": "Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: \n\\* `true` - all organization members can create private repositories. \n\\* `false` - only organization owners can create private repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of:
\n* true - all organization members can create public repositories.
\n* false - only organization owners can create public repositories.
\nDefault: true. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", + "name": "members_can_create_public_repositories", + "in": "body", + "rawType": "boolean", + "rawDescription": "Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: \n\\* `true` - all organization members can create public repositories. \n\\* `false` - only organization owners can create public repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

Specifies which types of repositories non-admin organization members can create. Can be one of:
\n* all - all organization members can create public and private repositories.
\n* private - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud.
\n* none - only admin members can create repositories.
\nNote: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See the parameter deprecation notice in the operation description for details.

", + "enum": [ + "all", + "private", + "none" + ], + "name": "members_allowed_repository_creation_type", + "in": "body", + "rawType": "string", + "rawDescription": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n\\* `none` - only admin members can create repositories. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Toggles whether organization members can create GitHub Pages sites. Can be one of:
\n* true - all organization members can create GitHub Pages sites.
\n* false - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.

", + "default": true, + "name": "members_can_create_pages", + "in": "body", + "rawType": "boolean", + "rawDescription": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Toggles whether organization members can create public GitHub Pages sites. Can be one of:
\n* true - all organization members can create public GitHub Pages sites.
\n* false - no organization members can create public GitHub Pages sites. Existing published sites will not be impacted.

", + "default": true, + "name": "members_can_create_public_pages", + "in": "body", + "rawType": "boolean", + "rawDescription": "Toggles whether organization members can create public GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create public GitHub Pages sites. \n\\* `false` - no organization members can create public GitHub Pages sites. Existing published sites will not be impacted.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Toggles whether organization members can create private GitHub Pages sites. Can be one of:
\n* true - all organization members can create private GitHub Pages sites.
\n* false - no organization members can create private GitHub Pages sites. Existing published sites will not be impacted.

", + "default": true, + "name": "members_can_create_private_pages", + "in": "body", + "rawType": "boolean", + "rawDescription": "Toggles whether organization members can create private GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create private GitHub Pages sites. \n\\* `false` - no organization members can create private GitHub Pages sites. Existing published sites will not be impacted.", + "childParamsGroups": [] + }, + { + "type": "string", + "example": "\"http://github.blog\"", + "name": "blog", + "in": "body", + "rawType": "string", + "description": "

undefined

", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"type\": \"Organization\",\n  \"total_private_repos\": 100,\n  \"owned_private_repos\": 100,\n  \"private_gists\": 81,\n  \"disk_usage\": 10000,\n  \"collaborators\": 8,\n  \"billing_email\": \"mona@github.com\",\n  \"plan\": {\n    \"name\": \"Medium\",\n    \"space\": 400,\n    \"private_repos\": 20\n  },\n  \"default_repository_permission\": \"read\",\n  \"members_can_create_repositories\": true,\n  \"two_factor_requirement_enabled\": true,\n  \"members_allowed_repository_creation_type\": \"all\",\n  \"members_can_create_public_repositories\": false,\n  \"members_can_create_private_repositories\": false,\n  \"members_can_create_internal_repositories\": false,\n  \"members_can_create_pages\": true,\n  \"updated_at\": \"2014-03-03T18:58:10Z\"\n}\n
" + }, + { + "httpStatusCode": "409", + "httpStatusMessage": "Conflict", + "description": "Conflict" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/actions/permissions", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/permissions", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/permissions
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/actions/permissions', {\n org: 'org'\n})", + "html": "
await octokit.request('GET /orgs/{org}/actions/permissions', {\n  org: 'org'\n})\n
" + } + ], + "summary": "Get GitHub Actions permissions for an organization", + "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/get-github-actions-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-github-actions-permissions-for-an-organization" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "slug": "get-github-actions-permissions-for-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.

\n

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"enabled_repositories\": \"all\",\n  \"allowed_actions\": \"selected\",\n  \"selected_actions_url\": \"https://api.github.com/organizations/42/actions/permissions/selected-actions\"\n}\n
" + } + ] + }, + { + "verb": "put", + "requestPath": "/orgs/{org}/actions/permissions", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/permissions \\\n -d '{\"enabled_repositories\":\"enabled_repositories\"}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/permissions \\\n  -d '{\"enabled_repositories\":\"enabled_repositories\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /orgs/{org}/actions/permissions', {\n org: 'org',\n enabled_repositories: 'enabled_repositories'\n})", + "html": "
await octokit.request('PUT /orgs/{org}/actions/permissions', {\n  org: 'org',\n  enabled_repositories: 'enabled_repositories'\n})\n
" + } + ], + "summary": "Set GitHub Actions permissions for an organization", + "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/set-github-actions-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-github-actions-permissions-for-an-organization" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_repositories": { + "type": "string", + "description": "

Required. The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: all, none, or selected.

", + "enum": [ + "all", + "none", + "selected" + ], + "name": "enabled_repositories", + "in": "body", + "rawType": "string", + "rawDescription": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "childParamsGroups": [] + }, + "allowed_actions": { + "type": "string", + "description": "

The permissions policy that controls the actions that are allowed to run. Can be one of: all, local_only, or selected.

", + "enum": [ + "all", + "local_only", + "selected" + ], + "name": "allowed_actions", + "in": "body", + "rawType": "string", + "rawDescription": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "childParamsGroups": [] + } + }, + "required": [ + "enabled_repositories" + ] + }, + "example": { + "enabled_repositories": "all", + "allowed_actions": "selected" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "slug": "set-github-actions-permissions-for-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "descriptionHTML": "

Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.

\n

If the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as allowed_actions to selected actions, then you cannot override them for the organization.

\n

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

", + "bodyParameters": [ + { + "type": "string", + "description": "

Required. The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: all, none, or selected.

", + "enum": [ + "all", + "none", + "selected" + ], + "name": "enabled_repositories", + "in": "body", + "rawType": "string", + "rawDescription": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The permissions policy that controls the actions that are allowed to run. Can be one of: all, local_only, or selected.

", + "enum": [ + "all", + "local_only", + "selected" + ], + "name": "allowed_actions", + "in": "body", + "rawType": "string", + "rawDescription": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "childParamsGroups": [] + } + ] + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/actions/permissions/repositories", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/permissions/repositories", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/permissions/repositories
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/actions/permissions/repositories', {\n org: 'org'\n})", + "html": "
await octokit.request('GET /orgs/{org}/actions/permissions/repositories', {\n  org: 'org'\n})\n
" + } + ], + "summary": "List selected repositories enabled for GitHub Actions in an organization", + "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/list-selected-repositories-enabled-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "slug": "list-selected-repositories-enabled-for-github-actions-in-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"total_count\": 1,\n  \"repositories\": [\n    {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World\",\n      \"full_name\": \"octocat/Hello-World\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"template_repository\": null,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://github.com/licenses/mit\"\n      },\n      \"forks\": 1,\n      \"open_issues\": 1,\n      \"watchers\": 1\n    }\n  ]\n}\n
" + } + ] + }, + { + "verb": "put", + "requestPath": "/orgs/{org}/actions/permissions/repositories", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/permissions/repositories \\\n -d '{\"selected_repository_ids\":[42]}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/permissions/repositories \\\n  -d '{\"selected_repository_ids\":[42]}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /orgs/{org}/actions/permissions/repositories', {\n org: 'org',\n selected_repository_ids: [\n 42\n ]\n})", + "html": "
await octokit.request('PUT /orgs/{org}/actions/permissions/repositories', {\n  org: 'org',\n  selected_repository_ids: [\n    42\n  ]\n})\n
" + } + ], + "summary": "Set selected repositories enabled for GitHub Actions in an organization", + "description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/set-selected-repositories-enabled-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "description": "

Required. List of repository IDs to enable for GitHub Actions.

", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + }, + "name": "selected_repository_ids", + "in": "body", + "rawType": "array", + "rawDescription": "List of repository IDs to enable for GitHub Actions.", + "childParamsGroups": [] + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "example": { + "selected_repository_ids": [ + 32, + 42 + ] + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "slug": "set-selected-repositories-enabled-for-github-actions-in-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "descriptionHTML": "

Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

", + "bodyParameters": [ + { + "description": "

Required. List of repository IDs to enable for GitHub Actions.

", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + }, + "name": "selected_repository_ids", + "in": "body", + "rawType": "array", + "rawDescription": "List of repository IDs to enable for GitHub Actions.", + "childParamsGroups": [] + } + ] + }, + { + "verb": "put", + "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/permissions/repositories/42", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/permissions/repositories/42
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /orgs/{org}/actions/permissions/repositories/{repository_id}', {\n org: 'org',\n repository_id: 42\n})", + "html": "
await octokit.request('PUT /orgs/{org}/actions/permissions/repositories/{repository_id}', {\n  org: 'org',\n  repository_id: 42\n})\n
" + } + ], + "summary": "Enable a selected repository for GitHub Actions in an organization", + "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/enable-selected-repository-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "slug": "enable-a-selected-repository-for-github-actions-in-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

" + }, + { + "verb": "delete", + "requestPath": "/orgs/{org}/actions/permissions/repositories/{repository_id}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/permissions/repositories/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/permissions/repositories/42
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}', {\n org: 'org',\n repository_id: 42\n})", + "html": "
await octokit.request('DELETE /orgs/{org}/actions/permissions/repositories/{repository_id}', {\n  org: 'org',\n  repository_id: 42\n})\n
" + } + ], + "summary": "Disable a selected repository for GitHub Actions in an organization", + "description": "Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/disable-selected-repository-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "slug": "disable-a-selected-repository-for-github-actions-in-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for enabled_repositories must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

" + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/actions/permissions/selected-actions", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/permissions/selected-actions", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/permissions/selected-actions
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/actions/permissions/selected-actions', {\n org: 'org'\n})", + "html": "
await octokit.request('GET /orgs/{org}/actions/permissions/selected-actions', {\n  org: 'org'\n})\n
" + } + ], + "summary": "Get allowed actions for an organization", + "description": "Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/get-allowed-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-allowed-actions-for-an-organization" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "slug": "get-allowed-actions-for-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"\"

\n

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"github_owned_allowed\": true,\n  \"verified_allowed\": false,\n  \"patterns_allowed\": [\n    \"monalisa/octocat@*\",\n    \"docker/*\"\n  ]\n}\n
" + } + ] + }, + { + "verb": "put", + "requestPath": "/orgs/{org}/actions/permissions/selected-actions", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/permissions/selected-actions \\\n -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"],\"verified_allowed\":true}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/permissions/selected-actions \\\n  -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"],\"verified_allowed\":true}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /orgs/{org}/actions/permissions/selected-actions', {\n org: 'org',\n github_owned_allowed: true,\n patterns_allowed: [\n 'patterns_allowed'\n ],\n verified_allowed: true\n})", + "html": "
await octokit.request('PUT /orgs/{org}/actions/permissions/selected-actions', {\n  org: 'org',\n  github_owned_allowed: true,\n  patterns_allowed: [\n    'patterns_allowed'\n  ],\n  verified_allowed: true\n})\n
" + } + ], + "summary": "Set allowed actions for an organization", + "description": "Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/set-allowed-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-allowed-actions-for-an-organization" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "

Required. Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", + "name": "github_owned_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", + "childParamsGroups": [] + }, + "verified_allowed": { + "type": "boolean", + "description": "

Required. Whether actions in GitHub Marketplace from verified creators are allowed. Set to true to allow all GitHub Marketplace actions by verified creators.

", + "name": "verified_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators.", + "childParamsGroups": [] + }, + "patterns_allowed": { + "type": "array of strings", + "description": "

Required. Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", + "items": { + "type": "string" + }, + "name": "patterns_allowed", + "in": "body", + "rawType": "array", + "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "childParamsGroups": [] + } + }, + "required": [ + "github_owned_allowed", + "patterns_allowed", + "verified_allowed" + ] + }, + "examples": { + "selected_actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "slug": "set-allowed-actions-for-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "descriptionHTML": "

Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for an organization.\"

\n

If the organization belongs to an enterprise that has selected actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.

\n

To use the patterns_allowed setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories in the organization.

\n

You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the administration organization permission to use this API.

", + "bodyParameters": [ + { + "type": "boolean", + "description": "

Required. Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", + "name": "github_owned_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Required. Whether actions in GitHub Marketplace from verified creators are allowed. Set to true to allow all GitHub Marketplace actions by verified creators.

", + "name": "verified_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

Required. Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", + "items": { + "type": "string" + }, + "name": "patterns_allowed", + "in": "body", + "rawType": "array", + "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "childParamsGroups": [] + } + ] + }, + { + "verb": "post", + "requestPath": "/orgs/{org}/actions/runner-groups", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups \\\n -d '{\"name\":\"name\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups \\\n  -d '{\"name\":\"name\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /orgs/{org}/actions/runner-groups', {\n org: 'org',\n name: 'name'\n})", + "html": "
await octokit.request('POST /orgs/{org}/actions/runner-groups', {\n  org: 'org',\n  name: 'name'\n})\n
" + } + ], + "summary": "Create a self-hosted runner group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nCreates a new self-hosted runner group for an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/create-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#create-a-self-hosted-runner-group-for-an-organization" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "

Required. Name of the runner group.

", + "type": "string", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "Name of the runner group.", + "childParamsGroups": [] + }, + "visibility": { + "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: all, selected, or private.

", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ], + "default": "all", + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: `all`, `selected`, or `private`.", + "childParamsGroups": [] + }, + "selected_repository_ids": { + "description": "

List of repository IDs that can access the runner group.

", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + }, + "name": "selected_repository_ids", + "in": "body", + "rawType": "array", + "rawDescription": "List of repository IDs that can access the runner group.", + "childParamsGroups": [] + }, + "runners": { + "description": "

List of runner IDs to add to the runner group.

", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + }, + "name": "runners", + "in": "body", + "rawType": "array", + "rawDescription": "List of runner IDs to add to the runner group.", + "childParamsGroups": [] + } + }, + "required": [ + "name" + ] + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected", + "selected_repository_ids": [ + 32, + 91 + ], + "runners": [ + 9, + 2 + ] + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "slug": "create-a-self-hosted-runner-group-for-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "self-hosted-runner-groups", + "subcategoryLabel": "Self hosted runner groups", + "notes": [], + "descriptionHTML": "

The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see \"GitHub's products.\"

\n

Creates a new self-hosted runner group for an organization.

\n

You must authenticate using an access token with the admin:org scope to use this endpoint.

", + "bodyParameters": [ + { + "description": "

Required. Name of the runner group.

", + "type": "string", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "Name of the runner group.", + "childParamsGroups": [] + }, + { + "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: all, selected, or private.

", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ], + "default": "all", + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: `all`, `selected`, or `private`.", + "childParamsGroups": [] + }, + { + "description": "

List of repository IDs that can access the runner group.

", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + }, + "name": "selected_repository_ids", + "in": "body", + "rawType": "array", + "rawDescription": "List of repository IDs that can access the runner group.", + "childParamsGroups": [] + }, + { + "description": "

List of runner IDs to add to the runner group.

", + "type": "array of integers", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + }, + "name": "runners", + "in": "body", + "rawType": "array", + "rawDescription": "List of runner IDs to add to the runner group.", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Default response", + "payload": "
{\n  \"id\": 2,\n  \"name\": \"octo-runner-group\",\n  \"visibility\": \"selected\",\n  \"default\": false,\n  \"selected_repositories_url\": \"https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories\",\n  \"runners_url\": \"https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners\",\n  \"inherited\": false,\n  \"allows_public_repositories\": true\n}\n
" + } + ] + }, + { + "verb": "patch", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

Unique identifier of the self-hosted runner group.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42 \\\n  -d '{\"name\":\"name\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PATCH /orgs/{org}/actions/runner-groups/{runner_group_id}', {\n org: 'org',\n runner_group_id: 42,\n name: 'name'\n})", + "html": "
await octokit.request('PATCH /orgs/{org}/actions/runner-groups/{runner_group_id}', {\n  org: 'org',\n  runner_group_id: 42,\n  name: 'name'\n})\n
" + } + ], + "summary": "Update a self-hosted runner group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nUpdates the `name` and `visibility` of a self-hosted runner group in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/update-self-hosted-runner-group-for-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#update-a-self-hosted-runner-group-for-an-organization" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "

Name of the runner group.

", + "type": "string", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "Name of the runner group.", + "childParamsGroups": [] + }, + "visibility": { + "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: all, selected, or private.

", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ], + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: `all`, `selected`, or `private`.", + "childParamsGroups": [] + } + } + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "slug": "update-a-self-hosted-runner-group-for-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "self-hosted-runner-groups", + "subcategoryLabel": "Self hosted runner groups", + "notes": [], + "descriptionHTML": "

The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"GitHub's products.\"

\n

Updates the name and visibility of a self-hosted runner group in an organization.

\n

You must authenticate using an access token with the admin:org scope to use this endpoint.

", + "bodyParameters": [ + { + "description": "

Name of the runner group.

", + "type": "string", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "Name of the runner group.", + "childParamsGroups": [] + }, + { + "description": "

Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: all, selected, or private.

", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ], + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: `all`, `selected`, or `private`.", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"id\": 2,\n  \"name\": \"octo-runner-group\",\n  \"visibility\": \"selected\",\n  \"default\": false,\n  \"selected_repositories_url\": \"https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories\",\n  \"runners_url\": \"https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners\",\n  \"inherited\": false,\n  \"allows_public_repositories\": true\n}\n
" + } + ] + }, + { + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runner-groups/{runner_group_id}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

Unique identifier of the self-hosted runner group.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runner-groups/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runner-groups/42
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /orgs/{org}/actions/runner-groups/{runner_group_id}', {\n org: 'org',\n runner_group_id: 42\n})", + "html": "
await octokit.request('DELETE /orgs/{org}/actions/runner-groups/{runner_group_id}', {\n  org: 'org',\n  runner_group_id: 42\n})\n
" + } + ], + "summary": "Delete a self-hosted runner group from an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nDeletes a self-hosted runner group for an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/delete-self-hosted-runner-group-from-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-a-self-hosted-runner-group-from-an-organization" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + }, + "slug": "delete-a-self-hosted-runner-group-from-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "self-hosted-runner-groups", + "subcategoryLabel": "Self hosted runner groups", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"GitHub's products.\"

\n

Deletes a self-hosted runner group for an organization.

\n

You must authenticate using an access token with the admin:org scope to use this endpoint.

" + }, + { + "verb": "delete", + "requestPath": "/orgs/{org}/actions/runners/{runner_id}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

Unique identifier of the self-hosted runner.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/runners/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/runners/42
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /orgs/{org}/actions/runners/{runner_id}', {\n org: 'org',\n runner_id: 42\n})", + "html": "
await octokit.request('DELETE /orgs/{org}/actions/runners/{runner_id}', {\n  org: 'org',\n  runner_id: 42\n})\n
" + } + ], + "summary": "Delete a self-hosted runner from an organization", + "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-self-hosted-runner-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runners" + }, + "slug": "delete-a-self-hosted-runner-from-an-organization", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "self-hosted-runners", + "subcategoryLabel": "Self hosted runners", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

\n

You must authenticate using an access token with the admin:org scope to use this endpoint.

" + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/actions/secrets", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/actions/secrets', {\n org: 'org'\n})", + "html": "
await octokit.request('GET /orgs/{org}/actions/secrets', {\n  org: 'org'\n})\n
" + } + ], + "summary": "List organization secrets", + "description": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-org-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-organization-secrets" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "list-organization-secrets", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"total_count\": 3,\n  \"secrets\": [\n    {\n      \"name\": \"GIST_ID\",\n      \"created_at\": \"2019-08-10T14:59:22Z\",\n      \"updated_at\": \"2020-01-10T14:59:22Z\",\n      \"visibility\": \"private\"\n    },\n    {\n      \"name\": \"DEPLOY_TOKEN\",\n      \"created_at\": \"2019-08-10T14:59:22Z\",\n      \"updated_at\": \"2020-01-10T14:59:22Z\",\n      \"visibility\": \"all\"\n    },\n    {\n      \"name\": \"GH_TOKEN\",\n      \"created_at\": \"2019-08-10T14:59:22Z\",\n      \"updated_at\": \"2020-01-10T14:59:22Z\",\n      \"visibility\": \"selected\",\n      \"selected_repositories_url\": \"https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories\"\n    }\n  ]\n}\n
" + } + ] + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/actions/secrets/public-key", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/public-key", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/public-key
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/actions/secrets/public-key', {\n org: 'org'\n})", + "html": "
await octokit.request('GET /orgs/{org}/actions/secrets/public-key', {\n  org: 'org'\n})\n
" + } + ], + "summary": "Get an organization public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-org-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-organization-public-key" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "get-an-organization-public-key", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"key_id\": \"012345678912345678\",\n  \"key\": \"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"\n}\n
" + } + ] + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

secret_name parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/actions/secrets/{secret_name}', {\n org: 'org',\n secret_name: 'secret_name'\n})", + "html": "
await octokit.request('GET /orgs/{org}/actions/secrets/{secret_name}', {\n  org: 'org',\n  secret_name: 'secret_name'\n})\n
" + } + ], + "summary": "Get an organization secret", + "description": "Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-organization-secret" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "get-an-organization-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"name\": \"GH_TOKEN\",\n  \"created_at\": \"2019-08-10T14:59:22Z\",\n  \"updated_at\": \"2020-01-10T14:59:22Z\",\n  \"visibility\": \"selected\",\n  \"selected_repositories_url\": \"https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories\"\n}\n
" + } + ] + }, + { + "verb": "put", + "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

secret_name parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME \\\n -d '{\"encrypted_value\":\"encrypted_value\"}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME \\\n  -d '{\"encrypted_value\":\"encrypted_value\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /orgs/{org}/actions/secrets/{secret_name}', {\n org: 'org',\n secret_name: 'secret_name',\n encrypted_value: 'encrypted_value'\n})", + "html": "
await octokit.request('PUT /orgs/{org}/actions/secrets/{secret_name}', {\n  org: 'org',\n  secret_name: 'secret_name',\n  encrypted_value: 'encrypted_value'\n})\n
" + } + ], + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to\nuse this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "tags": [ + "actions" + ], + "operationId": "actions/create-or-update-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", + "name": "encrypted_value", + "in": "body", + "rawType": "string", + "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-organization-public-key) endpoint.", + "childParamsGroups": [] + }, + "key_id": { + "type": "string", + "description": "

ID of the key you used to encrypt the secret.

", + "name": "key_id", + "in": "body", + "rawType": "string", + "rawDescription": "ID of the key you used to encrypt the secret.", + "childParamsGroups": [] + }, + "visibility": { + "type": "string", + "description": "

Configures the access that repositories have to the organization secret. Can be one of:
\n- all - All repositories in an organization can access the secret.
\n- private - Private repositories in an organization can access the secret.
\n- selected - Only specific repositories can access the secret.

", + "enum": [ + "all", + "private", + "selected" + ], + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Configures the access that repositories have to the organization secret. Can be one of: \n\\- `all` - All repositories in an organization can access the secret. \n\\- `private` - Private repositories in an organization can access the secret. \n\\- `selected` - Only specific repositories can access the secret.", + "childParamsGroups": [] + }, + "selected_repository_ids": { + "type": "array of strings", + "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

", + "items": { + "type": "string" + }, + "name": "selected_repository_ids", + "in": "body", + "rawType": "array", + "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", + "childParamsGroups": [] + } + } + }, + "example": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + "1296269", + "1296280" + ] + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "create-or-update-an-organization-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response when creating a secret" + }, + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response when updating a secret" + } + ], + "descriptionHTML": "

Creates or updates an organization secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to\nuse this endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the tweetsodium library.

\n
const sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n  \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n  public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n  sealed_box = public.SealedBox(public_key)\n  encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n  return b64encode(encrypted).decode(\"utf-8\")\n
\n

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n
\n

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n
", + "bodyParameters": [ + { + "type": "string", + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an organization public key endpoint.

", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", + "name": "encrypted_value", + "in": "body", + "rawType": "string", + "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-organization-public-key) endpoint.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

ID of the key you used to encrypt the secret.

", + "name": "key_id", + "in": "body", + "rawType": "string", + "rawDescription": "ID of the key you used to encrypt the secret.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

Configures the access that repositories have to the organization secret. Can be one of:
\n- all - All repositories in an organization can access the secret.
\n- private - Private repositories in an organization can access the secret.
\n- selected - Only specific repositories can access the secret.

", + "enum": [ + "all", + "private", + "selected" + ], + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Configures the access that repositories have to the organization secret. Can be one of: \n\\- `all` - All repositories in an organization can access the secret. \n\\- `private` - Private repositories in an organization can access the secret. \n\\- `selected` - Only specific repositories can access the secret.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can manage the list of selected repositories using the List selected repositories for an organization secret, Set selected repositories for an organization secret, and Remove selected repository from an organization secret endpoints.

", + "items": { + "type": "string" + }, + "name": "selected_repository_ids", + "in": "body", + "rawType": "array", + "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", + "childParamsGroups": [] + } + ] + }, + { + "verb": "delete", + "requestPath": "/orgs/{org}/actions/secrets/{secret_name}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

secret_name parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /orgs/{org}/actions/secrets/{secret_name}', {\n org: 'org',\n secret_name: 'secret_name'\n})", + "html": "
await octokit.request('DELETE /orgs/{org}/actions/secrets/{secret_name}', {\n  org: 'org',\n  secret_name: 'secret_name'\n})\n
" + } + ], + "summary": "Delete an organization secret", + "description": "Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-an-organization-secret" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "delete-an-organization-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Deletes a secret in an organization using the secret name. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

" + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

secret_name parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/actions/secrets/{secret_name}/repositories', {\n org: 'org',\n secret_name: 'secret_name'\n})", + "html": "
await octokit.request('GET /orgs/{org}/actions/secrets/{secret_name}/repositories', {\n  org: 'org',\n  secret_name: 'secret_name'\n})\n
" + } + ], + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-selected-repositories-for-an-organization-secret" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "list-selected-repositories-for-an-organization-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Lists all repositories that have been selected when the visibility for repository access to a secret is set to selected. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"total_count\": 1,\n  \"repositories\": [\n    {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World\",\n      \"full_name\": \"octocat/Hello-World\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n      \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n    }\n  ]\n}\n
" + } + ] + }, + { + "verb": "put", + "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

secret_name parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories \\\n -d '{\"selected_repository_ids\":[42]}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories \\\n  -d '{\"selected_repository_ids\":[42]}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /orgs/{org}/actions/secrets/{secret_name}/repositories', {\n org: 'org',\n secret_name: 'secret_name',\n selected_repository_ids: [\n 42\n ]\n})", + "html": "
await octokit.request('PUT /orgs/{org}/actions/secrets/{secret_name}/repositories', {\n  org: 'org',\n  secret_name: 'secret_name',\n  selected_repository_ids: [\n    42\n  ]\n})\n
" + } + ], + "summary": "Set selected repositories for an organization secret", + "description": "Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array of integers", + "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", + "items": { + "type": "integer" + }, + "name": "selected_repository_ids", + "in": "body", + "rawType": "array", + "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", + "childParamsGroups": [] + } + } + }, + "example": { + "selected_repository_ids": [ + 64780797 + ] + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "set-selected-repositories-for-an-organization-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "descriptionHTML": "

Replaces all repositories for an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

", + "bodyParameters": [ + { + "type": "array of integers", + "description": "

An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the visibility is set to selected. You can add and remove individual repositories using the Set selected repositories for an organization secret and Remove selected repository from an organization secret endpoints.

", + "items": { + "type": "integer" + }, + "name": "selected_repository_ids", + "in": "body", + "rawType": "array", + "rawDescription": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", + "childParamsGroups": [] + } + ] + }, + { + "verb": "put", + "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

secret_name parameter

" + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}', {\n org: 'org',\n secret_name: 'secret_name',\n repository_id: 42\n})", + "html": "
await octokit.request('PUT /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}', {\n  org: 'org',\n  secret_name: 'secret_name',\n  repository_id: 42\n})\n
" + } + ], + "summary": "Add selected repository to an organization secret", + "description": "Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/add-selected-repo-to-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#add-selected-repository-to-an-organization-secret" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "add-selected-repository-to-an-organization-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response when repository was added to the selected list" + }, + { + "httpStatusCode": "409", + "httpStatusMessage": "Conflict", + "description": "Response when visibility type is not set to selected" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Adds a repository to an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

" + }, + { + "verb": "delete", + "requestPath": "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

secret_name parameter

" + }, + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/actions/secrets/SECRET_NAME/repositories/42
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}', {\n org: 'org',\n secret_name: 'secret_name',\n repository_id: 42\n})", + "html": "
await octokit.request('DELETE /orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}', {\n  org: 'org',\n  secret_name: 'secret_name',\n  repository_id: 42\n})\n
" + } + ], + "summary": "Remove selected repository from an organization secret", + "description": "Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-selected-repo-from-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "remove-selected-repository-from-an-organization-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response when repository was removed from the selected list" + }, + { + "httpStatusCode": "409", + "httpStatusMessage": "Conflict", + "description": "Response when visibility type not set to selected" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Removes a repository from an organization secret when the visibility for repository access is set to selected. The visibility is set when you Create or update an organization secret. You must authenticate using an access token with the admin:org scope to use this endpoint. GitHub Apps must have the secrets organization permission to use this endpoint.

" + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/events", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/events", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/events
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/events', {\n org: 'org'\n})", + "html": "
await octokit.request('GET /orgs/{org}/events', {\n  org: 'org'\n})\n
" + } + ], + "summary": "List public organization events", + "description": "", + "tags": [ + "activity" + ], + "operationId": "activity/list-public-org-events", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#list-public-organization-events" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "activity", + "subcategory": "events" + }, + "slug": "list-public-organization-events", + "category": "activity", + "categoryLabel": "Activity", + "subcategory": "events", + "subcategoryLabel": "Events", + "notes": [], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "" + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/hooks", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/hooks', {\n org: 'org'\n})", + "html": "
await octokit.request('GET /orgs/{org}/hooks', {\n  org: 'org'\n})\n
" + } + ], + "summary": "List organization webhooks", + "description": "", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-webhooks", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#list-organization-webhooks" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "webhooks" + }, + "slug": "list-organization-webhooks", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "webhooks", + "subcategoryLabel": "Webhooks", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
[\n  {\n    \"id\": 1,\n    \"url\": \"https://api.github.com/orgs/octocat/hooks/1\",\n    \"ping_url\": \"https://api.github.com/orgs/octocat/hooks/1/pings\",\n    \"name\": \"web\",\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ],\n    \"active\": true,\n    \"config\": {\n      \"url\": \"http://example.com\",\n      \"content_type\": \"json\"\n    },\n    \"updated_at\": \"2011-09-06T20:39:23Z\",\n    \"created_at\": \"2011-09-06T17:26:27Z\",\n    \"type\": \"Organization\"\n  }\n]\n
" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + } + ] + }, + { + "verb": "post", + "requestPath": "/orgs/{org}/hooks", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /orgs/{org}/hooks', {\n org: 'org',\n name: 'name',\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl',\n username: 'username',\n password: 'password'\n }\n})", + "html": "
await octokit.request('POST /orgs/{org}/hooks', {\n  org: 'org',\n  name: 'name',\n  config: {\n    url: 'url',\n    content_type: 'content_type',\n    secret: 'secret',\n    insecure_ssl: 'insecure_ssl',\n    username: 'username',\n    password: 'password'\n  }\n})\n
" + } + ], + "summary": "Create an organization webhook", + "description": "Here's how you can create a hook that posts payloads in JSON format:", + "tags": [ + "orgs" + ], + "operationId": "orgs/create-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#create-an-organization-webhook" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "

Required. Must be passed as \"web\".

", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "Must be passed as \"web\".", + "childParamsGroups": [] + }, + "config": { + "type": "object", + "description": "

Required. Key/value pairs to provide settings for this webhook. These are defined below.

", + "properties": { + "url": { + "type": "string", + "description": "

Required. The URL to which the payloads will be delivered.

", + "example": "https://example.com/webhook", + "format": "uri", + "name": "url", + "in": "body", + "rawType": "string", + "rawDescription": "The URL to which the payloads will be delivered.", + "childParamsGroups": [] + }, + "content_type": { + "type": "string", + "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", + "example": "\"json\"", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "childParamsGroups": [] + }, + "secret": { + "type": "string", + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

", + "example": "\"********\"", + "name": "secret", + "in": "body", + "rawType": "string", + "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "childParamsGroups": [] + }, + "insecure_ssl": { + "type": "string", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "example": "\"0\"", + "name": "insecure_ssl", + "in": "body", + "rawType": "string", + "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "childParamsGroups": [] + }, + "username": { + "type": "string", + "example": "\"kdaigle\"", + "name": "username", + "in": "body", + "rawType": "string", + "description": "

undefined

", + "childParamsGroups": [] + }, + "password": { + "type": "string", + "example": "\"password\"", + "name": "password", + "in": "body", + "rawType": "string", + "description": "

undefined

", + "childParamsGroups": [] + } + }, + "required": [ + "url" + ], + "name": "config", + "in": "body", + "rawType": "object", + "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/github-ae@latest/rest/reference/orgs#create-hook-config-params).", + "childParamsGroups": [ + { + "parentName": "config", + "parentType": "object", + "id": "config-object", + "params": [ + { + "type": "string", + "description": "

Required. The URL to which the payloads will be delivered.

", + "example": "https://example.com/webhook", + "format": "uri", + "name": "url", + "in": "body", + "rawType": "string", + "rawDescription": "The URL to which the payloads will be delivered.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", + "example": "\"json\"", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

", + "example": "\"********\"", + "name": "secret", + "in": "body", + "rawType": "string", + "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "example": "\"0\"", + "name": "insecure_ssl", + "in": "body", + "rawType": "string", + "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "childParamsGroups": [] + }, + { + "type": "string", + "example": "\"kdaigle\"", + "name": "username", + "in": "body", + "rawType": "string", + "description": "

undefined

", + "childParamsGroups": [] + }, + { + "type": "string", + "example": "\"password\"", + "name": "password", + "in": "body", + "rawType": "string", + "description": "

undefined

", + "childParamsGroups": [] + } + ] + } + ] + }, + "events": { + "type": "array of strings", + "description": "

Determines what events the hook is triggered for.

", + "default": [ + "push" + ], + "items": { + "type": "string" + }, + "name": "events", + "in": "body", + "rawType": "array", + "rawDescription": "Determines what [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) the hook is triggered for.", + "childParamsGroups": [] + }, + "active": { + "type": "boolean", + "description": "

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

", + "default": true, + "name": "active", + "in": "body", + "rawType": "boolean", + "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "childParamsGroups": [] + } + }, + "required": [ + "name", + "config" + ] + }, + "example": { + "name": "web", + "active": true, + "events": [ + "push", + "pull_request" + ], + "config": { + "url": "http://example.com/webhook", + "content_type": "json" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "webhooks" + }, + "slug": "create-an-organization-webhook", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "webhooks", + "subcategoryLabel": "Webhooks", + "notes": [], + "descriptionHTML": "

Here's how you can create a hook that posts payloads in JSON format:

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Default response", + "payload": "
{\n  \"id\": 1,\n  \"url\": \"https://api.github.com/orgs/octocat/hooks/1\",\n  \"ping_url\": \"https://api.github.com/orgs/octocat/hooks/1/pings\",\n  \"name\": \"web\",\n  \"events\": [\n    \"push\",\n    \"pull_request\"\n  ],\n  \"active\": true,\n  \"config\": {\n    \"url\": \"http://example.com\",\n    \"content_type\": \"json\"\n  },\n  \"updated_at\": \"2011-09-06T20:39:23Z\",\n  \"created_at\": \"2011-09-06T17:26:27Z\",\n  \"type\": \"Organization\"\n}\n
" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ], + "bodyParameters": [ + { + "type": "string", + "description": "

Required. Must be passed as \"web\".

", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "Must be passed as \"web\".", + "childParamsGroups": [] + }, + { + "type": "object", + "description": "

Required. Key/value pairs to provide settings for this webhook. These are defined below.

", + "properties": { + "url": { + "type": "string", + "description": "

Required. The URL to which the payloads will be delivered.

", + "example": "https://example.com/webhook", + "format": "uri", + "name": "url", + "in": "body", + "rawType": "string", + "rawDescription": "The URL to which the payloads will be delivered.", + "childParamsGroups": [] + }, + "content_type": { + "type": "string", + "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", + "example": "\"json\"", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "childParamsGroups": [] + }, + "secret": { + "type": "string", + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

", + "example": "\"********\"", + "name": "secret", + "in": "body", + "rawType": "string", + "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "childParamsGroups": [] + }, + "insecure_ssl": { + "type": "string", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "example": "\"0\"", + "name": "insecure_ssl", + "in": "body", + "rawType": "string", + "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "childParamsGroups": [] + }, + "username": { + "type": "string", + "example": "\"kdaigle\"", + "name": "username", + "in": "body", + "rawType": "string", + "description": "

undefined

", + "childParamsGroups": [] + }, + "password": { + "type": "string", + "example": "\"password\"", + "name": "password", + "in": "body", + "rawType": "string", + "description": "

undefined

", + "childParamsGroups": [] + } + }, + "required": [ + "url" + ], + "name": "config", + "in": "body", + "rawType": "object", + "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/github-ae@latest/rest/reference/orgs#create-hook-config-params).", + "childParamsGroups": [ + { + "parentName": "config", + "parentType": "object", + "id": "config-object", + "params": [ + { + "type": "string", + "description": "

Required. The URL to which the payloads will be delivered.

", + "example": "https://example.com/webhook", + "format": "uri", + "name": "url", + "in": "body", + "rawType": "string", + "rawDescription": "The URL to which the payloads will be delivered.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", + "example": "\"json\"", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

", + "example": "\"********\"", + "name": "secret", + "in": "body", + "rawType": "string", + "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "example": "\"0\"", + "name": "insecure_ssl", + "in": "body", + "rawType": "string", + "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "childParamsGroups": [] + }, + { + "type": "string", + "example": "\"kdaigle\"", + "name": "username", + "in": "body", + "rawType": "string", + "description": "

undefined

", + "childParamsGroups": [] + }, + { + "type": "string", + "example": "\"password\"", + "name": "password", + "in": "body", + "rawType": "string", + "description": "

undefined

", + "childParamsGroups": [] + } + ] + } + ] + }, + { + "type": "array of strings", + "description": "

Determines what events the hook is triggered for.

", + "default": [ + "push" + ], + "items": { + "type": "string" + }, + "name": "events", + "in": "body", + "rawType": "array", + "rawDescription": "Determines what [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) the hook is triggered for.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

", + "default": true, + "name": "active", + "in": "body", + "rawType": "boolean", + "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "childParamsGroups": [] + } + ] + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/hooks/{hook_id}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "hook_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/hooks/{hook_id}', {\n org: 'org',\n hook_id: 42\n})", + "html": "
await octokit.request('GET /orgs/{org}/hooks/{hook_id}', {\n  org: 'org',\n  hook_id: 42\n})\n
" + } + ], + "summary": "Get an organization webhook", + "description": "Returns a webhook configured in an organization. To get only the webhook `config` properties, see \"[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization).\"", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#get-an-organization-webhook" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "webhooks" + }, + "slug": "get-an-organization-webhook", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "webhooks", + "subcategoryLabel": "Webhooks", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Returns a webhook configured in an organization. To get only the webhook config properties, see \"Get a webhook configuration for an organization.\"

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"id\": 1,\n  \"url\": \"https://api.github.com/orgs/octocat/hooks/1\",\n  \"ping_url\": \"https://api.github.com/orgs/octocat/hooks/1/pings\",\n  \"name\": \"web\",\n  \"events\": [\n    \"push\",\n    \"pull_request\"\n  ],\n  \"active\": true,\n  \"config\": {\n    \"url\": \"http://example.com\",\n    \"content_type\": \"json\"\n  },\n  \"updated_at\": \"2011-09-06T20:39:23Z\",\n  \"created_at\": \"2011-09-06T17:26:27Z\",\n  \"type\": \"Organization\"\n}\n
" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + } + ] + }, + { + "verb": "patch", + "requestPath": "/orgs/{org}/hooks/{hook_id}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "hook_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", + "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PATCH /orgs/{org}/hooks/{hook_id}', {\n org: 'org',\n hook_id: 42,\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl'\n }\n})", + "html": "
await octokit.request('PATCH /orgs/{org}/hooks/{hook_id}', {\n  org: 'org',\n  hook_id: 42,\n  config: {\n    url: 'url',\n    content_type: 'content_type',\n    secret: 'secret',\n    insecure_ssl: 'insecure_ssl'\n  }\n})\n
" + } + ], + "summary": "Update an organization webhook", + "description": "Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization).\"", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#update-an-organization-webhook" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "config": { + "type": "object", + "description": "

Key/value pairs to provide settings for this webhook. These are defined below.

", + "properties": { + "url": { + "type": "string", + "description": "

Required. The URL to which the payloads will be delivered.

", + "example": "https://example.com/webhook", + "format": "uri", + "name": "url", + "in": "body", + "rawType": "string", + "rawDescription": "The URL to which the payloads will be delivered.", + "childParamsGroups": [] + }, + "content_type": { + "type": "string", + "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", + "example": "\"json\"", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "childParamsGroups": [] + }, + "secret": { + "type": "string", + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

", + "example": "\"********\"", + "name": "secret", + "in": "body", + "rawType": "string", + "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "childParamsGroups": [] + }, + "insecure_ssl": { + "type": "string", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "example": "\"0\"", + "name": "insecure_ssl", + "in": "body", + "rawType": "string", + "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "childParamsGroups": [] + } + }, + "required": [ + "url" + ], + "name": "config", + "in": "body", + "rawType": "object", + "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/github-ae@latest/rest/reference/orgs#update-hook-config-params).", + "childParamsGroups": [ + { + "parentName": "config", + "parentType": "object", + "id": "config-object", + "params": [ + { + "type": "string", + "description": "

Required. The URL to which the payloads will be delivered.

", + "example": "https://example.com/webhook", + "format": "uri", + "name": "url", + "in": "body", + "rawType": "string", + "rawDescription": "The URL to which the payloads will be delivered.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", + "example": "\"json\"", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

", + "example": "\"********\"", + "name": "secret", + "in": "body", + "rawType": "string", + "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "example": "\"0\"", + "name": "insecure_ssl", + "in": "body", + "rawType": "string", + "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "childParamsGroups": [] + } + ] + } + ] + }, + "events": { + "type": "array of strings", + "description": "

Determines what events the hook is triggered for.

", + "default": [ + "push" + ], + "items": { + "type": "string" + }, + "name": "events", + "in": "body", + "rawType": "array", + "rawDescription": "Determines what [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) the hook is triggered for.", + "childParamsGroups": [] + }, + "active": { + "type": "boolean", + "description": "

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

", + "default": true, + "name": "active", + "in": "body", + "rawType": "boolean", + "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "childParamsGroups": [] + }, + "name": { + "type": "string", + "example": "\"web\"", + "name": "name", + "in": "body", + "rawType": "string", + "description": "

undefined

", + "childParamsGroups": [] + } + } + }, + "example": { + "active": true, + "events": [ + "pull_request" + ] + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "webhooks" + }, + "slug": "update-an-organization-webhook", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "webhooks", + "subcategoryLabel": "Webhooks", + "notes": [], + "descriptionHTML": "

Updates a webhook configured in an organization. When you update a webhook, the secret will be overwritten. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for an organization.\"

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"id\": 1,\n  \"url\": \"https://api.github.com/orgs/octocat/hooks/1\",\n  \"ping_url\": \"https://api.github.com/orgs/octocat/hooks/1/pings\",\n  \"name\": \"web\",\n  \"events\": [\n    \"pull_request\"\n  ],\n  \"active\": true,\n  \"config\": {\n    \"url\": \"http://example.com\",\n    \"content_type\": \"json\"\n  },\n  \"updated_at\": \"2011-09-06T20:39:23Z\",\n  \"created_at\": \"2011-09-06T17:26:27Z\",\n  \"type\": \"Organization\"\n}\n
" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ], + "bodyParameters": [ + { + "type": "object", + "description": "

Key/value pairs to provide settings for this webhook. These are defined below.

", + "properties": { + "url": { + "type": "string", + "description": "

Required. The URL to which the payloads will be delivered.

", + "example": "https://example.com/webhook", + "format": "uri", + "name": "url", + "in": "body", + "rawType": "string", + "rawDescription": "The URL to which the payloads will be delivered.", + "childParamsGroups": [] + }, + "content_type": { + "type": "string", + "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", + "example": "\"json\"", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "childParamsGroups": [] + }, + "secret": { + "type": "string", + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

", + "example": "\"********\"", + "name": "secret", + "in": "body", + "rawType": "string", + "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "childParamsGroups": [] + }, + "insecure_ssl": { + "type": "string", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "example": "\"0\"", + "name": "insecure_ssl", + "in": "body", + "rawType": "string", + "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "childParamsGroups": [] + } + }, + "required": [ + "url" + ], + "name": "config", + "in": "body", + "rawType": "object", + "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/github-ae@latest/rest/reference/orgs#update-hook-config-params).", + "childParamsGroups": [ + { + "parentName": "config", + "parentType": "object", + "id": "config-object", + "params": [ + { + "type": "string", + "description": "

Required. The URL to which the payloads will be delivered.

", + "example": "https://example.com/webhook", + "format": "uri", + "name": "url", + "in": "body", + "rawType": "string", + "rawDescription": "The URL to which the payloads will be delivered.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", + "example": "\"json\"", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

", + "example": "\"********\"", + "name": "secret", + "in": "body", + "rawType": "string", + "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "example": "\"0\"", + "name": "insecure_ssl", + "in": "body", + "rawType": "string", + "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "childParamsGroups": [] + } + ] + } + ] + }, + { + "type": "array of strings", + "description": "

Determines what events the hook is triggered for.

", + "default": [ + "push" + ], + "items": { + "type": "string" + }, + "name": "events", + "in": "body", + "rawType": "array", + "rawDescription": "Determines what [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) the hook is triggered for.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

", + "default": true, + "name": "active", + "in": "body", + "rawType": "boolean", + "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "childParamsGroups": [] + }, + { + "type": "string", + "example": "\"web\"", + "name": "name", + "in": "body", + "rawType": "string", + "description": "

undefined

", + "childParamsGroups": [] + } + ] + }, + { + "verb": "delete", + "requestPath": "/orgs/{org}/hooks/{hook_id}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "hook_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /orgs/{org}/hooks/{hook_id}', {\n org: 'org',\n hook_id: 42\n})", + "html": "
await octokit.request('DELETE /orgs/{org}/hooks/{hook_id}', {\n  org: 'org',\n  hook_id: 42\n})\n
" + } + ], + "summary": "Delete an organization webhook", + "description": "", + "tags": [ + "orgs" + ], + "operationId": "orgs/delete-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#delete-an-organization-webhook" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "webhooks" + }, + "slug": "delete-an-organization-webhook", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "webhooks", + "subcategoryLabel": "Webhooks", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + } + ], + "bodyParameters": [], + "descriptionHTML": "" + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/hooks/{hook_id}/config", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "hook_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42/config", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42/config
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/hooks/{hook_id}/config', {\n org: 'org',\n hook_id: 42\n})", + "html": "
await octokit.request('GET /orgs/{org}/hooks/{hook_id}/config', {\n  org: 'org',\n  hook_id: 42\n})\n
" + } + ], + "summary": "Get a webhook configuration for an organization", + "description": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook).\"\n\nAccess tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-webhook-config-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#get-a-webhook-configuration-for-an-organization" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "webhooks" + }, + "slug": "get-a-webhook-configuration-for-an-organization", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "webhooks", + "subcategoryLabel": "Webhooks", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Returns the webhook configuration for an organization. To get more information about the webhook, including the active state and events, use \"Get an organization webhook .\"

\n

Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:read permission.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" + } + ] + }, + { + "verb": "patch", + "requestPath": "/orgs/{org}/hooks/{hook_id}/config", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "hook_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42/config \\\n -d '{\"url\":\"url\"}'", + "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42/config \\\n  -d '{\"url\":\"url\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PATCH /orgs/{org}/hooks/{hook_id}/config', {\n org: 'org',\n hook_id: 42,\n url: 'url'\n})", + "html": "
await octokit.request('PATCH /orgs/{org}/hooks/{hook_id}/config', {\n  org: 'org',\n  hook_id: 42,\n  url: 'url'\n})\n
" + } + ], + "summary": "Update a webhook configuration for an organization", + "description": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook).\"\n\nAccess tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission.", + "tags": [ + "orgs" + ], + "operationId": "orgs/update-webhook-config-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#update-a-webhook-configuration-for-an-organization" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "

The URL to which the payloads will be delivered.

", + "example": "https://example.com/webhook", + "format": "uri", + "name": "url", + "in": "body", + "rawType": "string", + "rawDescription": "The URL to which the payloads will be delivered.", + "childParamsGroups": [] + }, + "content_type": { + "type": "string", + "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", + "example": "\"json\"", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "childParamsGroups": [] + }, + "secret": { + "type": "string", + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

", + "example": "\"********\"", + "name": "secret", + "in": "body", + "rawType": "string", + "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "childParamsGroups": [] + }, + "insecure_ssl": { + "type": "string", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "example": "\"0\"", + "name": "insecure_ssl", + "in": "body", + "rawType": "string", + "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "childParamsGroups": [] + } + }, + "example": { + "content_type": "json", + "insecure_ssl": "0", + "secret": "********", + "url": "https://example.com/webhook" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "webhooks" + }, + "slug": "update-a-webhook-configuration-for-an-organization", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "webhooks", + "subcategoryLabel": "Webhooks", + "notes": [], + "descriptionHTML": "

Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use \"Update an organization webhook .\"

\n

Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:write permission.

", + "bodyParameters": [ + { + "type": "string", + "description": "

The URL to which the payloads will be delivered.

", + "example": "https://example.com/webhook", + "format": "uri", + "name": "url", + "in": "body", + "rawType": "string", + "rawDescription": "The URL to which the payloads will be delivered.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", + "example": "\"json\"", + "name": "content_type", + "in": "body", + "rawType": "string", + "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

", + "example": "\"********\"", + "name": "secret", + "in": "body", + "rawType": "string", + "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", + "example": "\"0\"", + "name": "insecure_ssl", + "in": "body", + "rawType": "string", + "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" + } + ] + }, + { + "verb": "post", + "requestPath": "/orgs/{org}/hooks/{hook_id}/pings", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "hook_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42/pings", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42/pings
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /orgs/{org}/hooks/{hook_id}/pings', {\n org: 'org',\n hook_id: 42\n})", + "html": "
await octokit.request('POST /orgs/{org}/hooks/{hook_id}/pings', {\n  org: 'org',\n  hook_id: 42\n})\n
" + } + ], + "summary": "Ping an organization webhook", + "description": "This will trigger a [ping event](https://docs.github.com/github-ae@latest/webhooks/#ping-event) to be sent to the hook.", + "tags": [ + "orgs" + ], + "operationId": "orgs/ping-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#ping-an-organization-webhook" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "webhooks" + }, + "slug": "ping-an-organization-webhook", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "webhooks", + "subcategoryLabel": "Webhooks", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + } + ], + "bodyParameters": [], + "descriptionHTML": "

This will trigger a ping event to be sent to the hook.

" + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/installation", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/installation", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/installation
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/installation', {\n org: 'org'\n})", + "html": "
await octokit.request('GET /orgs/{org}/installation', {\n  org: 'org'\n})\n
" + } + ], + "summary": "Get an organization installation for the authenticated app", + "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/get-org-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/apps/#get-an-organization-installation-for-the-authenticated-app" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "apps", + "subcategory": null + }, + "slug": "get-an-organization-installation-for-the-authenticated-app", + "category": "apps", + "categoryLabel": "Apps", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Enables an authenticated GitHub App to find the organization's installation information.

\n

You must use a JWT to access this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"id\": 1,\n  \"account\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"html_url\": \"https://github.com/github\",\n    \"followers_url\": \"https://api.github.com/users/github/followers\",\n    \"following_url\": \"https://api.github.com/users/github/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/github/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/github/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/github/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/github/orgs\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"received_events_url\": \"https://api.github.com/users/github/received_events\",\n    \"type\": \"Organization\",\n    \"site_admin\": false\n  },\n  \"repository_selection\": \"all\",\n  \"access_tokens_url\": \"https://api.github.com/installations/1/access_tokens\",\n  \"repositories_url\": \"https://api.github.com/installation/repositories\",\n  \"html_url\": \"https://github.com/organizations/github/settings/installations/1\",\n  \"app_id\": 1,\n  \"target_id\": 1,\n  \"target_type\": \"Organization\",\n  \"permissions\": {\n    \"checks\": \"write\",\n    \"metadata\": \"read\",\n    \"contents\": \"read\"\n  },\n  \"events\": [\n    \"push\",\n    \"pull_request\"\n  ],\n  \"created_at\": \"2018-02-09T20:51:14Z\",\n  \"updated_at\": \"2018-02-09T20:51:14Z\",\n  \"single_file_name\": \"config.yml\",\n  \"has_multiple_single_files\": true,\n  \"single_file_paths\": [\n    \"config.yml\",\n    \".github/issue_TEMPLATE.md\"\n  ],\n  \"app_slug\": \"github-actions\"\n}\n
" + } + ] + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/installations", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/installations", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/installations
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/installations', {\n org: 'org'\n})", + "html": "
await octokit.request('GET /orgs/{org}/installations', {\n  org: 'org'\n})\n
" + } + ], + "summary": "List app installations for an organization", + "description": "Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-app-installations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs/#list-app-installations-for-an-organization" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": null + }, + "slug": "list-app-installations-for-an-organization", + "category": "orgs", + "categoryLabel": "Orgs", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with admin:read scope to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"total_count\": 1,\n  \"installations\": [\n    {\n      \"id\": 25381,\n      \"account\": {\n        \"login\": \"octo-org\",\n        \"id\": 6811672,\n        \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=\",\n        \"avatar_url\": \"https://avatars3.githubusercontent.com/u/6811672?v=4\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octo-org\",\n        \"html_url\": \"https://github.com/octo-org\",\n        \"followers_url\": \"https://api.github.com/users/octo-org/followers\",\n        \"following_url\": \"https://api.github.com/users/octo-org/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octo-org/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octo-org/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octo-org/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octo-org/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octo-org/repos\",\n        \"events_url\": \"https://api.github.com/users/octo-org/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octo-org/received_events\",\n        \"type\": \"Organization\",\n        \"site_admin\": false\n      },\n      \"repository_selection\": \"selected\",\n      \"access_tokens_url\": \"https://api.github.com/app/installations/25381/access_tokens\",\n      \"repositories_url\": \"https://api.github.com/installation/repositories\",\n      \"html_url\": \"https://github.com/organizations/octo-org/settings/installations/25381\",\n      \"app_id\": 2218,\n      \"target_id\": 6811672,\n      \"target_type\": \"Organization\",\n      \"permissions\": {\n        \"deployments\": \"write\",\n        \"metadata\": \"read\",\n        \"pull_requests\": \"read\",\n        \"statuses\": \"read\"\n      },\n      \"events\": [\n        \"deployment\",\n        \"deployment_status\"\n      ],\n      \"created_at\": \"2017-05-16T08:47:09.000-07:00\",\n      \"updated_at\": \"2017-06-06T11:23:23.000-07:00\",\n      \"single_file_name\": \"config.yml\",\n      \"has_multiple_single_files\": true,\n      \"single_file_paths\": [\n        \"config.yml\",\n        \".github/issue_TEMPLATE.md\"\n      ],\n      \"app_slug\": \"github-actions\"\n    }\n  ]\n}\n
" + } + ] + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/issues", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "filter", + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "assigned", + "created", + "mentioned", + "subscribed", + "all" + ], + "default": "assigned" + }, + "descriptionHTML": "

Indicates which sorts of issues to return. Can be one of:
\n* assigned: Issues assigned to you
\n* created: Issues created by you
\n* mentioned: Issues mentioning you
\n* subscribed: Issues you're subscribed to updates for
\n* all: All issues the authenticated user can see, regardless of participation or creation

" + }, + { + "name": "state", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + }, + "descriptionHTML": "

Indicates the state of the issues to return. Can be either open, closed, or all.

" + }, + { + "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

A list of comma separated label names. Example: bug,ui,@high

" + }, + { + "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "comments" + ], + "default": "created" + }, + "descriptionHTML": "

What to sort results by. Can be either created, updated, comments.

" + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

One of asc (ascending) or desc (descending).

" + }, + { + "name": "since", + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/issues", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/issues
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/issues', {\n org: 'org'\n})", + "html": "
await octokit.request('GET /orgs/{org}/issues', {\n  org: 'org'\n})\n
" + } + ], + "summary": "List organization issues assigned to the authenticated user", + "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests)\" endpoint.", + "tags": [ + "issues" + ], + "operationId": "issues/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/issues/#list-organization-issues-assigned-to-the-authenticated-user" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", + "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + } + ], + "category": "issues", + "subcategory": null + }, + "slug": "list-organization-issues-assigned-to-the-authenticated-user", + "category": "issues", + "categoryLabel": "Issues", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDU6SXNzdWUx\",\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n    \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n    \"number\": 1347,\n    \"state\": \"open\",\n    \"title\": \"Found a bug\",\n    \"body\": \"I'm having a problem with this.\",\n    \"user\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"labels\": [\n      {\n        \"id\": 208045946,\n        \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n        \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n        \"name\": \"bug\",\n        \"description\": \"Something isn't working\",\n        \"color\": \"f29513\",\n        \"default\": true\n      }\n    ],\n    \"assignee\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"assignees\": [\n      {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      }\n    ],\n    \"milestone\": {\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n      \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n      \"id\": 1002604,\n      \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n      \"number\": 1,\n      \"state\": \"open\",\n      \"title\": \"v1.0\",\n      \"description\": \"Tracking milestone for version 1.0\",\n      \"creator\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"open_issues\": 4,\n      \"closed_issues\": 8,\n      \"created_at\": \"2011-04-10T20:09:31Z\",\n      \"updated_at\": \"2014-03-03T18:58:10Z\",\n      \"closed_at\": \"2013-02-12T13:22:01Z\",\n      \"due_on\": \"2012-10-09T23:39:01Z\"\n    },\n    \"locked\": true,\n    \"active_lock_reason\": \"too heated\",\n    \"comments\": 0,\n    \"pull_request\": {\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n      \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n      \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n      \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n    },\n    \"closed_at\": null,\n    \"created_at\": \"2011-04-22T13:33:48Z\",\n    \"updated_at\": \"2011-04-22T13:33:48Z\",\n    \"repository\": {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World\",\n      \"full_name\": \"octocat/Hello-World\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"template_repository\": null,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://github.com/licenses/mit\"\n      },\n      \"forks\": 1,\n      \"open_issues\": 1,\n      \"watchers\": 1\n    },\n    \"author_association\": \"COLLABORATOR\"\n  }\n]\n
" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + } + ] + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/members", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "filter", + "description": "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. \n\\* `all` - All members the authenticated user can see.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "2fa_disabled", + "all" + ], + "default": "all" + }, + "descriptionHTML": "

Filter members returned in the list. Can be one of:
\n* 2fa_disabled - Members without two-factor authentication enabled. Available for organization owners.
\n* all - All members the authenticated user can see.

" + }, + { + "name": "role", + "description": "Filter members returned by their role. Can be one of: \n\\* `all` - All members of the organization, regardless of role. \n\\* `admin` - Organization owners. \n\\* `member` - Non-owner organization members.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "admin", + "member" + ], + "default": "all" + }, + "descriptionHTML": "

Filter members returned by their role. Can be one of:
\n* all - All members of the organization, regardless of role.
\n* admin - Organization owners.
\n* member - Non-owner organization members.

" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/members', {\n org: 'org'\n})", + "html": "
await octokit.request('GET /orgs/{org}/members', {\n  org: 'org'\n})\n
" + } + ], + "summary": "List organization members", + "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-members", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#list-organization-members" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "slug": "list-organization-members", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "members", + "subcategoryLabel": "Members", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
[\n  {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n]\n
" + }, + { + "httpStatusCode": "302", + "httpStatusMessage": "Found", + "description": "Response if requester is not an organization member" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/members/{username}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members/USERNAME
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/members/{username}', {\n org: 'org',\n username: 'username'\n})", + "html": "
await octokit.request('GET /orgs/{org}/members/{username}', {\n  org: 'org',\n  username: 'username'\n})\n
" + } + ], + "summary": "Check organization membership for a user", + "description": "Check if a user is, publicly or privately, a member of the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/check-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#check-organization-membership-for-a-user" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "slug": "check-organization-membership-for-a-user", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "members", + "subcategoryLabel": "Members", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response if requester is an organization member and user is a member" + }, + { + "httpStatusCode": "302", + "httpStatusMessage": "Found", + "description": "Response if requester is not an organization member" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Response if requester is an organization member and user is not a member" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Check if a user is, publicly or privately, a member of the organization.

" + }, + { + "verb": "delete", + "requestPath": "/orgs/{org}/members/{username}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members/USERNAME
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /orgs/{org}/members/{username}', {\n org: 'org',\n username: 'username'\n})", + "html": "
await octokit.request('DELETE /orgs/{org}/members/{username}', {\n  org: 'org',\n  username: 'username'\n})\n
" + } + ], + "summary": "Remove an organization member", + "description": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-member", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#remove-an-organization-member" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "slug": "remove-an-organization-member", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "members", + "subcategoryLabel": "Members", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.

" + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/memberships/{username}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/memberships/{username}', {\n org: 'org',\n username: 'username'\n})", + "html": "
await octokit.request('GET /orgs/{org}/memberships/{username}', {\n  org: 'org',\n  username: 'username'\n})\n
" + } + ], + "summary": "Get organization membership for a user", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#get-organization-membership-for-a-user" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "slug": "get-organization-membership-for-a-user", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "members", + "subcategoryLabel": "Members", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

In order to get a user's membership with an organization, the authenticated user must be an organization member.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response if user has an active admin membership with organization", + "payload": "
{\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n}\n
" + }, + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response if user has an active membership with organization", + "payload": "
{\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"member\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n}\n
" + }, + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response if user has a pending membership with organization", + "payload": "
{\n  \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n  \"state\": \"pending\",\n  \"role\": \"member\",\n  \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n}\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + } + ] + }, + { + "verb": "put", + "requestPath": "/orgs/{org}/memberships/{username}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /orgs/{org}/memberships/{username}', {\n org: 'org',\n username: 'username',\n role: 'role'\n})", + "html": "
await octokit.request('PUT /orgs/{org}/memberships/{username}', {\n  org: 'org',\n  username: 'username',\n  role: 'role'\n})\n
" + } + ], + "summary": "Set organization membership for a user", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/github-ae@latest/rest/reference/orgs#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "tags": [ + "orgs" + ], + "operationId": "orgs/set-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#set-organization-membership-for-a-user" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "type": "string", + "description": "

The role to give the user in the organization. Can be one of:
\n* admin - The user will become an owner of the organization.
\n* member - The user will become a non-owner member of the organization.

", + "enum": [ + "admin", + "member" + ], + "default": "member", + "name": "role", + "in": "body", + "rawType": "string", + "rawDescription": "The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.", + "childParamsGroups": [] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "slug": "set-organization-membership-for-a-user", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "members", + "subcategoryLabel": "Members", + "notes": [], + "descriptionHTML": "

Only authenticated organization owners can add a member to the organization or update the member's role.

\n
    \n
  • If the authenticated user is adding a member to the organization, the invited user will receive an email inviting them to the organization. The user's membership status will be pending until they accept the invitation.
    • \n
  • Authenticated users can update a user's membership by passing the role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.
    • \n
\n

Rate limits

\n

To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.

", + "bodyParameters": [ + { + "type": "string", + "description": "

The role to give the user in the organization. Can be one of:
\n* admin - The user will become an owner of the organization.
\n* member - The user will become a non-owner member of the organization.

", + "enum": [ + "admin", + "member" + ], + "default": "member", + "name": "role", + "in": "body", + "rawType": "string", + "rawDescription": "The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response if user was previously unaffiliated with organization", + "payload": "
{\n  \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n  \"state\": \"pending\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n}\n
" + }, + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response if user already had membership with organization", + "payload": "
{\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n}\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, + { + "verb": "delete", + "requestPath": "/orgs/{org}/memberships/{username}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /orgs/{org}/memberships/{username}', {\n org: 'org',\n username: 'username'\n})", + "html": "
await octokit.request('DELETE /orgs/{org}/memberships/{username}', {\n  org: 'org',\n  username: 'username'\n})\n
" + } + ], + "summary": "Remove organization membership for a user", + "description": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#remove-organization-membership-for-a-user" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "slug": "remove-organization-membership-for-a-user", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "members", + "subcategoryLabel": "Members", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + } + ], + "bodyParameters": [], + "descriptionHTML": "

In order to remove a user's membership with an organization, the authenticated user must be an organization owner.

\n

If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.

" + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/outside_collaborators", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "filter", + "description": "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. \n\\* `all`: All outside collaborators.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "2fa_disabled", + "all" + ], + "default": "all" + }, + "descriptionHTML": "

Filter the list of outside collaborators. Can be one of:
\n* 2fa_disabled: Outside collaborators without two-factor authentication enabled.
\n* all: All outside collaborators.

" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/outside_collaborators', {\n org: 'org'\n})", + "html": "
await octokit.request('GET /orgs/{org}/outside_collaborators', {\n  org: 'org'\n})\n
" + } + ], + "summary": "List outside collaborators for an organization", + "description": "List all users who are outside collaborators of an organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-outside-collaborators", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#list-outside-collaborators-for-an-organization" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "outside-collaborators" + }, + "slug": "list-outside-collaborators-for-an-organization", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "outside-collaborators", + "subcategoryLabel": "Outside collaborators", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

List all users who are outside collaborators of an organization.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
[\n  {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n]\n
" + } + ] + }, + { + "verb": "put", + "requestPath": "/orgs/{org}/outside_collaborators/{username}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators/USERNAME
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /orgs/{org}/outside_collaborators/{username}', {\n org: 'org',\n username: 'username'\n})", + "html": "
await octokit.request('PUT /orgs/{org}/outside_collaborators/{username}', {\n  org: 'org',\n  username: 'username'\n})\n
" + } + ], + "summary": "Convert an organization member to outside collaborator", + "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\".", + "tags": [ + "orgs" + ], + "operationId": "orgs/convert-member-to-outside-collaborator", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "outside-collaborators" + }, + "slug": "convert-an-organization-member-to-outside-collaborator", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "outside-collaborators", + "subcategoryLabel": "Outside collaborators", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".

", + "responses": [ + { + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "User is getting converted asynchronously" + }, + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "User was converted" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if user is the last owner of the organization", + "payload": "
{\n  \"message\": \"Cannot convert the last owner to an outside collaborator\",\n  \"documentation_url\": \"https://docs.github.com/github-ae@latest/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if user is not a member of the organization", + "payload": "
{\n  \"message\": \"<user> is not a member of the <organization> organization.\",\n  \"documentation_url\": \"https://docs.github.com/github-ae@latest/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + } + ] + }, + { + "verb": "delete", + "requestPath": "/orgs/{org}/outside_collaborators/{username}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators/USERNAME
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /orgs/{org}/outside_collaborators/{username}', {\n org: 'org',\n username: 'username'\n})", + "html": "
await octokit.request('DELETE /orgs/{org}/outside_collaborators/{username}', {\n  org: 'org',\n  username: 'username'\n})\n
" + } + ], + "summary": "Remove outside collaborator from an organization", + "description": "Removing a user from this list will remove them from all the organization's repositories.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-outside-collaborator", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#remove-outside-collaborator-from-an-organization" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "outside-collaborators" + }, + "slug": "remove-outside-collaborator-from-an-organization", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "outside-collaborators", + "subcategoryLabel": "Outside collaborators", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Removing a user from this list will remove them from all the organization's repositories.

", + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Response if user is a member of the organization", + "payload": "
{\n  \"message\": \"You cannot specify an organization member to remove as an outside collaborator.\",\n  \"documentation_url\": \"https://docs.github.com/github-ae@latest/rest/reference/orgs#remove-outside-collaborator\"\n}\n
" + } + ] + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/projects", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "state", + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + }, + "descriptionHTML": "

Indicates the state of the projects to return. Can be either open, closed, or all.

" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/projects
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/projects', {\n org: 'org',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('GET /orgs/{org}/projects', {\n  org: 'org',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + } + ], + "summary": "List organization projects", + "description": "Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "tags": [ + "projects" + ], + "operationId": "projects/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects/#list-organization-projects" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" + } + ], + "category": "projects", + "subcategory": null + }, + "slug": "list-organization-projects", + "category": "projects", + "categoryLabel": "Projects", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Lists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
[\n  {\n    \"owner_url\": \"https://api.github.com/orgs/octocat\",\n    \"url\": \"https://api.github.com/projects/1002605\",\n    \"html_url\": \"https://github.com/orgs/api-playground/projects/1\",\n    \"columns_url\": \"https://api.github.com/projects/1002605/columns\",\n    \"id\": 1002605,\n    \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDU=\",\n    \"name\": \"Organization Roadmap\",\n    \"body\": \"High-level roadmap for the upcoming year.\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"created_at\": \"2011-04-11T20:09:31Z\",\n    \"updated_at\": \"2014-03-04T18:58:10Z\"\n  }\n]\n
" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, + { + "verb": "post", + "requestPath": "/orgs/{org}/projects", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects \\\n -d '{\"name\":\"name\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/projects \\\n  -d '{\"name\":\"name\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /orgs/{org}/projects', {\n org: 'org',\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('POST /orgs/{org}/projects', {\n  org: 'org',\n  name: 'name',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + } + ], + "summary": "Create an organization project", + "description": "Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "tags": [ + "projects" + ], + "operationId": "projects/create-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects/#create-an-organization-project" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "

Required. The name of the project.

", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the project.", + "childParamsGroups": [] + }, + "body": { + "type": "string", + "description": "

The description of the project.

", + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The description of the project.", + "childParamsGroups": [] + } + }, + "required": [ + "name" + ] + }, + "example": { + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year." + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" + } + ], + "category": "projects", + "subcategory": null + }, + "slug": "create-an-organization-project", + "category": "projects", + "categoryLabel": "Projects", + "notes": [], + "descriptionHTML": "

Creates an organization project board. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

", + "bodyParameters": [ + { + "type": "string", + "description": "

Required. The name of the project.

", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the project.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The description of the project.

", + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The description of the project.", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Default response", + "payload": "
{\n  \"owner_url\": \"https://api.github.com/orgs/octocat\",\n  \"url\": \"https://api.github.com/projects/1002605\",\n  \"html_url\": \"https://github.com/orgs/api-playground/projects/1\",\n  \"columns_url\": \"https://api.github.com/projects/1002605/columns\",\n  \"id\": 1002605,\n  \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDU=\",\n  \"name\": \"Organization Roadmap\",\n  \"body\": \"High-level roadmap for the upcoming year.\",\n  \"number\": 1,\n  \"state\": \"open\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2011-04-11T20:09:31Z\",\n  \"updated_at\": \"2014-03-04T18:58:10Z\"\n}\n
" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/public_members", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/public_members', {\n org: 'org'\n})", + "html": "
await octokit.request('GET /orgs/{org}/public_members', {\n  org: 'org'\n})\n
" + } + ], + "summary": "List public organization members", + "description": "Members of an organization can choose to have their membership publicized or not.", + "tags": [ + "orgs" + ], + "operationId": "orgs/list-public-members", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#list-public-organization-members" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "slug": "list-public-organization-members", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "members", + "subcategoryLabel": "Members", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Members of an organization can choose to have their membership publicized or not.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
[\n  {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n]\n
" + } + ] + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/public_members/{username}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/public_members/{username}', {\n org: 'org',\n username: 'username'\n})", + "html": "
await octokit.request('GET /orgs/{org}/public_members/{username}', {\n  org: 'org',\n  username: 'username'\n})\n
" + } + ], + "summary": "Check public organization membership for a user", + "description": "", + "tags": [ + "orgs" + ], + "operationId": "orgs/check-public-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#check-public-organization-membership-for-a-user" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "slug": "check-public-organization-membership-for-a-user", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "members", + "subcategoryLabel": "Members", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response if user is a public member" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Response if user is not a public member" + } + ], + "bodyParameters": [], + "descriptionHTML": "" + }, + { + "verb": "put", + "requestPath": "/orgs/{org}/public_members/{username}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /orgs/{org}/public_members/{username}', {\n org: 'org',\n username: 'username'\n})", + "html": "
await octokit.request('PUT /orgs/{org}/public_members/{username}', {\n  org: 'org',\n  username: 'username'\n})\n
" + } + ], + "summary": "Set public organization membership for the authenticated user", + "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "tags": [ + "orgs" + ], + "operationId": "orgs/set-public-membership-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "slug": "set-public-organization-membership-for-the-authenticated-user", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "members", + "subcategoryLabel": "Members", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + } + ], + "bodyParameters": [], + "descriptionHTML": "

The user can publicize their own membership. (A user cannot publicize the membership for another user.)

\n

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

" + }, + { + "verb": "delete", + "requestPath": "/orgs/{org}/public_members/{username}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /orgs/{org}/public_members/{username}', {\n org: 'org',\n username: 'username'\n})", + "html": "
await octokit.request('DELETE /orgs/{org}/public_members/{username}', {\n  org: 'org',\n  username: 'username'\n})\n
" + } + ], + "summary": "Remove public organization membership for the authenticated user", + "description": "", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-public-membership-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "orgs", + "subcategory": "members" + }, + "slug": "remove-public-organization-membership-for-the-authenticated-user", + "category": "orgs", + "categoryLabel": "Orgs", + "subcategory": "members", + "subcategoryLabel": "Members", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "" + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/repos", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "type", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "public", + "private", + "forks", + "sources", + "member", + "internal" + ] + }, + "descriptionHTML": "

Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.

" + }, + { + "name": "sort", + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "pushed", + "full_name" + ], + "default": "created" + }, + "descriptionHTML": "

Can be one of created, updated, pushed, full_name.

" + }, + { + "name": "direction", + "description": "Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc`", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ] + }, + "descriptionHTML": "

Can be one of asc or desc. Default: when using full_name: asc, otherwise desc

" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/repos
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/repos', {\n org: 'org'\n})", + "html": "
await octokit.request('GET /orgs/{org}/repos', {\n  org: 'org'\n})\n
" + } + ], + "summary": "List organization repositories", + "description": "Lists repositories for the specified organization.", + "tags": [ + "repos" + ], + "operationId": "repos/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#list-organization-repositories" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "nebula", + "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```", + "html": "

You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.

\n

To access repository visibility during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.nebula-preview+json
" + }, + { + "required": false, + "name": "baptiste", + "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```", + "html": "

The is_template and template_repository keys are currently available for developer to preview. See Create a repository using a template to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json
" + } + ], + "category": "repos", + "subcategory": null + }, + "slug": "list-organization-repositories", + "category": "repos", + "categoryLabel": "Repos", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Lists repositories for the specified organization.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
[\n  {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": false,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"template_repository\": {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World-Template\",\n      \"full_name\": \"octocat/Hello-World-Template\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World-Template\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World-Template\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World-Template.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World-Template.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World-Template.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World-Template\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World-Template\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks\": 9,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"watchers\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues\": 0,\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://api.github.com/licenses/mit\"\n      },\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0\n    }\n  }\n]\n
" + } + ] + }, + { + "verb": "post", + "requestPath": "/orgs/{org}/repos", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos \\\n -d '{\"name\":\"name\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/repos \\\n  -d '{\"name\":\"name\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /orgs/{org}/repos', {\n org: 'org',\n name: 'name'\n})", + "html": "
await octokit.request('POST /orgs/{org}/repos', {\n  org: 'org',\n  name: 'name'\n})\n
" + } + ], + "summary": "Create an organization repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "tags": [ + "repos" + ], + "operationId": "repos/create-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#create-an-organization-repository" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { "type": "string", - "description": "

The publicly visible email address.

", - "name": "email", + "description": "

Required. The name of the repository.

", + "name": "name", "in": "body", "rawType": "string", - "rawDescription": "The publicly visible email address.", + "rawDescription": "The name of the repository.", "childParamsGroups": [] }, - "twitter_username": { + "description": { "type": "string", - "description": "

The Twitter username of the company.

", - "name": "twitter_username", + "description": "

A short description of the repository.

", + "name": "description", "in": "body", "rawType": "string", - "rawDescription": "The Twitter username of the company.", + "rawDescription": "A short description of the repository.", "childParamsGroups": [] }, - "location": { + "homepage": { "type": "string", - "description": "

The location.

", - "name": "location", + "description": "

A URL with more information about the repository.

", + "name": "homepage", "in": "body", "rawType": "string", - "rawDescription": "The location.", + "rawDescription": "A URL with more information about the repository.", "childParamsGroups": [] }, - "name": { - "type": "string", - "description": "

The shorthand name of the company.

", - "name": "name", + "private": { + "type": "boolean", + "description": "

Either true to create a private repository or false to create a public one.

", + "default": false, + "name": "private", "in": "body", - "rawType": "string", - "rawDescription": "The shorthand name of the company.", + "rawType": "boolean", + "rawDescription": "Either `true` to create a private repository or `false` to create a public one.", "childParamsGroups": [] }, - "description": { + "visibility": { "type": "string", - "description": "

The description of the company.

", - "name": "description", + "description": "

Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
\nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

", + "enum": [ + "public", + "private", + "visibility", + "internal" + ], + "name": "visibility", "in": "body", "rawType": "string", - "rawDescription": "The description of the company.", + "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "childParamsGroups": [] }, - "has_organization_projects": { + "has_issues": { "type": "boolean", - "description": "

Toggles whether an organization can use organization projects.

", - "name": "has_organization_projects", + "description": "

Either true to enable issues for this repository or false to disable them.

", + "default": true, + "name": "has_issues", "in": "body", "rawType": "boolean", - "rawDescription": "Toggles whether an organization can use organization projects.", + "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", "childParamsGroups": [] }, - "has_repository_projects": { + "has_projects": { "type": "boolean", - "description": "

Toggles whether repositories that belong to the organization can use repository projects.

", - "name": "has_repository_projects", + "description": "

Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

", + "default": true, + "name": "has_projects", "in": "body", "rawType": "boolean", - "rawDescription": "Toggles whether repositories that belong to the organization can use repository projects.", - "childParamsGroups": [] - }, - "default_repository_permission": { - "type": "string", - "description": "

Default permission level members have for organization repositories:
\n* read - can pull, but not push to or administer this repository.
\n* write - can pull and push, but not administer this repository.
\n* admin - can pull, push, and administer this repository.
\n* none - no permissions granted by default.

", - "enum": [ - "read", - "write", - "admin", - "none" - ], - "default": "read", - "name": "default_repository_permission", - "in": "body", - "rawType": "string", - "rawDescription": "Default permission level members have for organization repositories: \n\\* `read` - can pull, but not push to or administer this repository. \n\\* `write` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push, and administer this repository. \n\\* `none` - no permissions granted by default.", + "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", "childParamsGroups": [] }, - "members_can_create_repositories": { + "has_wiki": { "type": "boolean", - "description": "

Toggles the ability of non-admin organization members to create repositories. Can be one of:
\n* true - all organization members can create repositories.
\n* false - only organization owners can create repositories.
\nDefault: true
\nNote: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

", + "description": "

Either true to enable the wiki for this repository or false to disable it.

", "default": true, - "name": "members_can_create_repositories", + "name": "has_wiki", "in": "body", "rawType": "boolean", - "rawDescription": "Toggles the ability of non-admin organization members to create repositories. Can be one of: \n\\* `true` - all organization members can create repositories. \n\\* `false` - only organization owners can create repositories. \nDefault: `true` \n**Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", + "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", "childParamsGroups": [] }, - "members_can_create_internal_repositories": { + "is_template": { "type": "boolean", - "description": "

Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of:
\n* true - all organization members can create internal repositories.
\n* false - only organization owners can create internal repositories.
\nDefault: true. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", - "name": "members_can_create_internal_repositories", + "description": "

Either true to make this repo available as a template repository or false to prevent it.

", + "default": false, + "name": "is_template", "in": "body", "rawType": "boolean", - "rawDescription": "Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: \n\\* `true` - all organization members can create internal repositories. \n\\* `false` - only organization owners can create internal repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", "childParamsGroups": [] }, - "members_can_create_private_repositories": { - "type": "boolean", - "description": "

Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of:
\n* true - all organization members can create private repositories.
\n* false - only organization owners can create private repositories.
\nDefault: true. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", - "name": "members_can_create_private_repositories", + "team_id": { + "type": "integer", + "description": "

The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

", + "name": "team_id", "in": "body", - "rawType": "boolean", - "rawDescription": "Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: \n\\* `true` - all organization members can create private repositories. \n\\* `false` - only organization owners can create private repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "rawType": "integer", + "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", "childParamsGroups": [] }, - "members_can_create_public_repositories": { + "auto_init": { "type": "boolean", - "description": "

Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of:
\n* true - all organization members can create public repositories.
\n* false - only organization owners can create public repositories.
\nDefault: true. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", - "name": "members_can_create_public_repositories", + "description": "

Pass true to create an initial commit with empty README.

", + "default": false, + "name": "auto_init", "in": "body", "rawType": "boolean", - "rawDescription": "Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: \n\\* `true` - all organization members can create public repositories. \n\\* `false` - only organization owners can create public repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "rawDescription": "Pass `true` to create an initial commit with empty README.", "childParamsGroups": [] }, - "members_allowed_repository_creation_type": { + "gitignore_template": { "type": "string", - "description": "

Specifies which types of repositories non-admin organization members can create. Can be one of:
\n* all - all organization members can create public and private repositories.
\n* private - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud.
\n* none - only admin members can create repositories.
\nNote: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See the parameter deprecation notice in the operation description for details.

", - "enum": [ - "all", - "private", - "none" - ], - "name": "members_allowed_repository_creation_type", + "description": "

Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

", + "name": "gitignore_template", "in": "body", "rawType": "string", - "rawDescription": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n\\* `none` - only admin members can create repositories. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", + "rawDescription": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", "childParamsGroups": [] }, - "members_can_create_pages": { + "license_template": { + "type": "string", + "description": "

Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

", + "name": "license_template", + "in": "body", + "rawType": "string", + "rawDescription": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", + "childParamsGroups": [] + }, + "allow_squash_merge": { "type": "boolean", - "description": "

Toggles whether organization members can create GitHub Pages sites. Can be one of:
\n* true - all organization members can create GitHub Pages sites.
\n* false - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.

", + "description": "

Either true to allow squash-merging pull requests, or false to prevent squash-merging.

", "default": true, - "name": "members_can_create_pages", + "name": "allow_squash_merge", "in": "body", "rawType": "boolean", - "rawDescription": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.", + "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "childParamsGroups": [] }, - "members_can_create_public_pages": { + "allow_merge_commit": { "type": "boolean", - "description": "

Toggles whether organization members can create public GitHub Pages sites. Can be one of:
\n* true - all organization members can create public GitHub Pages sites.
\n* false - no organization members can create public GitHub Pages sites. Existing published sites will not be impacted.

", + "description": "

Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

", "default": true, - "name": "members_can_create_public_pages", + "name": "allow_merge_commit", "in": "body", "rawType": "boolean", - "rawDescription": "Toggles whether organization members can create public GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create public GitHub Pages sites. \n\\* `false` - no organization members can create public GitHub Pages sites. Existing published sites will not be impacted.", + "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", "childParamsGroups": [] }, - "members_can_create_private_pages": { + "allow_rebase_merge": { "type": "boolean", - "description": "

Toggles whether organization members can create private GitHub Pages sites. Can be one of:
\n* true - all organization members can create private GitHub Pages sites.
\n* false - no organization members can create private GitHub Pages sites. Existing published sites will not be impacted.

", + "description": "

Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

", "default": true, - "name": "members_can_create_private_pages", + "name": "allow_rebase_merge", "in": "body", "rawType": "boolean", - "rawDescription": "Toggles whether organization members can create private GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create private GitHub Pages sites. \n\\* `false` - no organization members can create private GitHub Pages sites. Existing published sites will not be impacted.", + "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "childParamsGroups": [] }, - "blog": { - "type": "string", - "example": "\"http://github.blog\"", - "name": "blog", + "delete_branch_on_merge": { + "type": "boolean", + "description": "

Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

", + "default": false, + "name": "delete_branch_on_merge", "in": "body", - "rawType": "string", - "description": "

undefined

", + "rawType": "boolean", + "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", "childParamsGroups": [] } - } + }, + "required": [ + "name" + ] }, "example": { - "billing_email": "mona@github.com", - "company": "GitHub", - "email": "mona@github.com", - "twitter_username": "github", - "location": "San Francisco", - "name": "github", - "description": "GitHub, the company.", - "default_repository_permission": "read", - "members_can_create_repositories": true, - "members_allowed_repository_creation_type": "all" + "name": "Hello-World", + "description": "This is your first repository", + "homepage": "https://github.com", + "private": false, + "has_issues": true, + "has_projects": true, + "has_wiki": true } } } @@ -10654,224 +18304,207 @@ "previews": [ { "required": false, - "name": "surtur", - "note": "New repository creation permissions are available to preview. You can now use `members_can_create_public_repositories`, `members_can_create_private_repositories`, and `members_can_create_internal_repositories`. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. These parameters provide more granular permissions to configure the type of repositories organization members can create.\n\nTo access these new parameters during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.surtur-preview+json\n```", - "html": "

New repository creation permissions are available to preview. You can now use members_can_create_public_repositories, members_can_create_private_repositories, and members_can_create_internal_repositories. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. These parameters provide more granular permissions to configure the type of repositories organization members can create.

\n

To access these new parameters during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.surtur-preview+json
" + "name": "nebula", + "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```", + "html": "

You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.

\n

To access repository visibility during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.nebula-preview+json
" + }, + { + "required": false, + "name": "baptiste", + "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```", + "html": "

The is_template and template_repository keys are currently available for developer to preview. See Create a repository using a template to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json
" } ], - "category": "orgs", + "category": "repos", "subcategory": null }, - "slug": "update-an-organization", - "category": "orgs", - "categoryLabel": "Orgs", + "slug": "create-an-organization-repository", + "category": "repos", + "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

Parameter Deprecation Notice: GitHub AE will replace and discontinue members_allowed_repository_creation_type in favor of more granular permissions. The new input parameters are members_can_create_public_repositories, members_can_create_private_repositories for all organizations and members_can_create_internal_repositories for organizations associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. For more information, see the blog post.

\n

Enables an authenticated organization owner with the admin:org scope to update the organization's profile and member privileges.

", + "descriptionHTML": "

Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

\n

OAuth scope requirements

\n

When using OAuth, authorizations must include:

\n
    \n
  • public_repo scope or repo scope to create a public repository
    • \n
  • repo scope to create a private repository
    • \n
", "bodyParameters": [ { "type": "string", - "description": "

Billing email address. This address is not publicized.

", - "name": "billing_email", - "in": "body", - "rawType": "string", - "rawDescription": "Billing email address. This address is not publicized.", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

The company name.

", - "name": "company", - "in": "body", - "rawType": "string", - "rawDescription": "The company name.", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

The publicly visible email address.

", - "name": "email", + "description": "

Required. The name of the repository.

", + "name": "name", "in": "body", "rawType": "string", - "rawDescription": "The publicly visible email address.", + "rawDescription": "The name of the repository.", "childParamsGroups": [] }, { "type": "string", - "description": "

The Twitter username of the company.

", - "name": "twitter_username", + "description": "

A short description of the repository.

", + "name": "description", "in": "body", "rawType": "string", - "rawDescription": "The Twitter username of the company.", + "rawDescription": "A short description of the repository.", "childParamsGroups": [] }, { "type": "string", - "description": "

The location.

", - "name": "location", + "description": "

A URL with more information about the repository.

", + "name": "homepage", "in": "body", "rawType": "string", - "rawDescription": "The location.", + "rawDescription": "A URL with more information about the repository.", "childParamsGroups": [] }, { - "type": "string", - "description": "

The shorthand name of the company.

", - "name": "name", + "type": "boolean", + "description": "

Either true to create a private repository or false to create a public one.

", + "default": false, + "name": "private", "in": "body", - "rawType": "string", - "rawDescription": "The shorthand name of the company.", + "rawType": "boolean", + "rawDescription": "Either `true` to create a private repository or `false` to create a public one.", "childParamsGroups": [] }, { "type": "string", - "description": "

The description of the company.

", - "name": "description", + "description": "

Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
\nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

", + "enum": [ + "public", + "private", + "visibility", + "internal" + ], + "name": "visibility", "in": "body", "rawType": "string", - "rawDescription": "The description of the company.", + "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "childParamsGroups": [] }, { "type": "boolean", - "description": "

Toggles whether an organization can use organization projects.

", - "name": "has_organization_projects", + "description": "

Either true to enable issues for this repository or false to disable them.

", + "default": true, + "name": "has_issues", "in": "body", "rawType": "boolean", - "rawDescription": "Toggles whether an organization can use organization projects.", + "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", "childParamsGroups": [] }, { "type": "boolean", - "description": "

Toggles whether repositories that belong to the organization can use repository projects.

", - "name": "has_repository_projects", + "description": "

Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

", + "default": true, + "name": "has_projects", "in": "body", "rawType": "boolean", - "rawDescription": "Toggles whether repositories that belong to the organization can use repository projects.", + "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", "childParamsGroups": [] }, { - "type": "string", - "description": "

Default permission level members have for organization repositories:
\n* read - can pull, but not push to or administer this repository.
\n* write - can pull and push, but not administer this repository.
\n* admin - can pull, push, and administer this repository.
\n* none - no permissions granted by default.

", - "enum": [ - "read", - "write", - "admin", - "none" - ], - "default": "read", - "name": "default_repository_permission", + "type": "boolean", + "description": "

Either true to enable the wiki for this repository or false to disable it.

", + "default": true, + "name": "has_wiki", "in": "body", - "rawType": "string", - "rawDescription": "Default permission level members have for organization repositories: \n\\* `read` - can pull, but not push to or administer this repository. \n\\* `write` - can pull and push, but not administer this repository. \n\\* `admin` - can pull, push, and administer this repository. \n\\* `none` - no permissions granted by default.", + "rawType": "boolean", + "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", "childParamsGroups": [] }, { "type": "boolean", - "description": "

Toggles the ability of non-admin organization members to create repositories. Can be one of:
\n* true - all organization members can create repositories.
\n* false - only organization owners can create repositories.
\nDefault: true
\nNote: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details. Note: A parameter can override this parameter. See members_allowed_repository_creation_type in this table for details.

", - "default": true, - "name": "members_can_create_repositories", + "description": "

Either true to make this repo available as a template repository or false to prevent it.

", + "default": false, + "name": "is_template", "in": "body", "rawType": "boolean", - "rawDescription": "Toggles the ability of non-admin organization members to create repositories. Can be one of: \n\\* `true` - all organization members can create repositories. \n\\* `false` - only organization owners can create repositories. \nDefault: `true` \n**Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details. **Note:** A parameter can override this parameter. See `members_allowed_repository_creation_type` in this table for details.", + "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", "childParamsGroups": [] }, { - "type": "boolean", - "description": "

Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of:
\n* true - all organization members can create internal repositories.
\n* false - only organization owners can create internal repositories.
\nDefault: true. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", - "name": "members_can_create_internal_repositories", + "type": "integer", + "description": "

The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

", + "name": "team_id", "in": "body", - "rawType": "boolean", - "rawDescription": "Toggles whether organization members can create internal repositories, which are visible to all enterprise members. You can only allow members to create internal repositories if your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+. Can be one of: \n\\* `true` - all organization members can create internal repositories. \n\\* `false` - only organization owners can create internal repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "rawType": "integer", + "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", "childParamsGroups": [] }, { "type": "boolean", - "description": "

Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of:
\n* true - all organization members can create private repositories.
\n* false - only organization owners can create private repositories.
\nDefault: true. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", - "name": "members_can_create_private_repositories", + "description": "

Pass true to create an initial commit with empty README.

", + "default": false, + "name": "auto_init", "in": "body", "rawType": "boolean", - "rawDescription": "Toggles whether organization members can create private repositories, which are visible to organization members with permission. Can be one of: \n\\* `true` - all organization members can create private repositories. \n\\* `false` - only organization owners can create private repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "rawDescription": "Pass `true` to create an initial commit with empty README.", "childParamsGroups": [] }, { - "type": "boolean", - "description": "

Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of:
\n* true - all organization members can create public repositories.
\n* false - only organization owners can create public repositories.
\nDefault: true. For more information, see \"Restricting repository creation in your organization\" in the GitHub Help documentation.

", - "name": "members_can_create_public_repositories", + "type": "string", + "description": "

Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

", + "name": "gitignore_template", "in": "body", - "rawType": "boolean", - "rawDescription": "Toggles whether organization members can create public repositories, which are visible to anyone. Can be one of: \n\\* `true` - all organization members can create public repositories. \n\\* `false` - only organization owners can create public repositories. \nDefault: `true`. For more information, see \"[Restricting repository creation in your organization](https://help.github.com/github/setting-up-and-managing-organizations-and-teams/restricting-repository-creation-in-your-organization)\" in the GitHub Help documentation.", + "rawType": "string", + "rawDescription": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", "childParamsGroups": [] }, { "type": "string", - "description": "

Specifies which types of repositories non-admin organization members can create. Can be one of:
\n* all - all organization members can create public and private repositories.
\n* private - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud.
\n* none - only admin members can create repositories.
\nNote: This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in members_can_create_repositories. See the parameter deprecation notice in the operation description for details.

", - "enum": [ - "all", - "private", - "none" - ], - "name": "members_allowed_repository_creation_type", + "description": "

Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

", + "name": "license_template", "in": "body", "rawType": "string", - "rawDescription": "Specifies which types of repositories non-admin organization members can create. Can be one of: \n\\* `all` - all organization members can create public and private repositories. \n\\* `private` - members can create private repositories. This option is only available to repositories that are part of an organization on GitHub Enterprise Cloud. \n\\* `none` - only admin members can create repositories. \n**Note:** This parameter is deprecated and will be removed in the future. Its return value ignores internal repositories. Using this parameter overrides values set in `members_can_create_repositories`. See the parameter deprecation notice in the operation description for details.", + "rawDescription": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", "childParamsGroups": [] }, { "type": "boolean", - "description": "

Toggles whether organization members can create GitHub Pages sites. Can be one of:
\n* true - all organization members can create GitHub Pages sites.
\n* false - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.

", + "description": "

Either true to allow squash-merging pull requests, or false to prevent squash-merging.

", "default": true, - "name": "members_can_create_pages", + "name": "allow_squash_merge", "in": "body", "rawType": "boolean", - "rawDescription": "Toggles whether organization members can create GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create GitHub Pages sites. \n\\* `false` - no organization members can create GitHub Pages sites. Existing published sites will not be impacted.", + "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", "childParamsGroups": [] }, { "type": "boolean", - "description": "

Toggles whether organization members can create public GitHub Pages sites. Can be one of:
\n* true - all organization members can create public GitHub Pages sites.
\n* false - no organization members can create public GitHub Pages sites. Existing published sites will not be impacted.

", + "description": "

Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

", "default": true, - "name": "members_can_create_public_pages", + "name": "allow_merge_commit", "in": "body", "rawType": "boolean", - "rawDescription": "Toggles whether organization members can create public GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create public GitHub Pages sites. \n\\* `false` - no organization members can create public GitHub Pages sites. Existing published sites will not be impacted.", + "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", "childParamsGroups": [] }, { "type": "boolean", - "description": "

Toggles whether organization members can create private GitHub Pages sites. Can be one of:
\n* true - all organization members can create private GitHub Pages sites.
\n* false - no organization members can create private GitHub Pages sites. Existing published sites will not be impacted.

", + "description": "

Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

", "default": true, - "name": "members_can_create_private_pages", + "name": "allow_rebase_merge", "in": "body", "rawType": "boolean", - "rawDescription": "Toggles whether organization members can create private GitHub Pages sites. Can be one of: \n\\* `true` - all organization members can create private GitHub Pages sites. \n\\* `false` - no organization members can create private GitHub Pages sites. Existing published sites will not be impacted.", + "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", "childParamsGroups": [] }, { - "type": "string", - "example": "\"http://github.blog\"", - "name": "blog", + "type": "boolean", + "description": "

Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

", + "default": false, + "name": "delete_branch_on_merge", "in": "body", - "rawType": "string", - "description": "

undefined

", + "rawType": "boolean", + "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", "childParamsGroups": [] } ], "responses": [ { - "httpStatusCode": "200", - "httpStatusMessage": "OK", + "httpStatusCode": "201", + "httpStatusMessage": "Created", "description": "Default response", - "payload": "
{\n  \"login\": \"github\",\n  \"id\": 1,\n  \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n  \"url\": \"https://api.github.com/orgs/github\",\n  \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n  \"events_url\": \"https://api.github.com/orgs/github/events\",\n  \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n  \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n  \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n  \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n  \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n  \"description\": \"A great organization\",\n  \"name\": \"github\",\n  \"company\": \"GitHub\",\n  \"blog\": \"https://github.com/blog\",\n  \"location\": \"San Francisco\",\n  \"email\": \"octocat@github.com\",\n  \"twitter_username\": \"github\",\n  \"is_verified\": true,\n  \"has_organization_projects\": true,\n  \"has_repository_projects\": true,\n  \"public_repos\": 2,\n  \"public_gists\": 1,\n  \"followers\": 20,\n  \"following\": 0,\n  \"html_url\": \"https://github.com/octocat\",\n  \"created_at\": \"2008-01-14T04:33:35Z\",\n  \"type\": \"Organization\",\n  \"total_private_repos\": 100,\n  \"owned_private_repos\": 100,\n  \"private_gists\": 81,\n  \"disk_usage\": 10000,\n  \"collaborators\": 8,\n  \"billing_email\": \"mona@github.com\",\n  \"plan\": {\n    \"name\": \"Medium\",\n    \"space\": 400,\n    \"private_repos\": 20\n  },\n  \"default_repository_permission\": \"read\",\n  \"members_can_create_repositories\": true,\n  \"two_factor_requirement_enabled\": true,\n  \"members_allowed_repository_creation_type\": \"all\",\n  \"members_can_create_public_repositories\": false,\n  \"members_can_create_private_repositories\": false,\n  \"members_can_create_internal_repositories\": false,\n  \"members_can_create_pages\": true,\n  \"updated_at\": \"2014-03-03T18:58:10Z\"\n}\n
" - }, - { - "httpStatusCode": "409", - "httpStatusMessage": "Conflict", - "description": "Conflict" + "payload": "
{\n  \"id\": 1296269,\n  \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n  \"name\": \"Hello-World\",\n  \"full_name\": \"octocat/Hello-World\",\n  \"owner\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"private\": false,\n  \"html_url\": \"https://github.com/octocat/Hello-World\",\n  \"description\": \"This your first repo!\",\n  \"fork\": false,\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n  \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n  \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n  \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n  \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n  \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n  \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n  \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n  \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n  \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n  \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n  \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n  \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n  \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n  \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n  \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n  \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n  \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n  \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n  \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n  \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n  \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n  \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n  \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n  \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n  \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n  \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n  \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n  \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n  \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n  \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n  \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n  \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n  \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n  \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n  \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n  \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n  \"homepage\": \"https://github.com\",\n  \"language\": null,\n  \"forks\": 9,\n  \"forks_count\": 9,\n  \"stargazers_count\": 80,\n  \"watchers_count\": 80,\n  \"watchers\": 80,\n  \"size\": 108,\n  \"default_branch\": \"master\",\n  \"open_issues\": 0,\n  \"open_issues_count\": 0,\n  \"is_template\": true,\n  \"license\": {\n    \"key\": \"mit\",\n    \"name\": \"MIT License\",\n    \"url\": \"https://api.github.com/licenses/mit\",\n    \"spdx_id\": \"MIT\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n    \"html_url\": \"https://api.github.com/licenses/mit\"\n  },\n  \"topics\": [\n    \"octocat\",\n    \"atom\",\n    \"electron\",\n    \"api\"\n  ],\n  \"has_issues\": true,\n  \"has_projects\": true,\n  \"has_wiki\": true,\n  \"has_pages\": false,\n  \"has_downloads\": true,\n  \"archived\": false,\n  \"disabled\": false,\n  \"visibility\": \"public\",\n  \"pushed_at\": \"2011-01-26T19:06:43Z\",\n  \"created_at\": \"2011-01-26T19:01:12Z\",\n  \"updated_at\": \"2011-01-26T19:14:43Z\",\n  \"permissions\": {\n    \"admin\": false,\n    \"push\": false,\n    \"pull\": true\n  },\n  \"allow_rebase_merge\": true,\n  \"template_repository\": null,\n  \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n  \"allow_squash_merge\": true,\n  \"delete_branch_on_merge\": true,\n  \"allow_merge_commit\": true,\n  \"subscribers_count\": 42,\n  \"network_count\": 0\n}\n
" }, { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" }, { "httpStatusCode": "422", @@ -10882,87 +18515,7 @@ }, { "verb": "get", - "requestPath": "/orgs/{org}/events", - "serverUrl": "https://api.github.com", - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - }, - "descriptionHTML": "

Results per page (max 100).

" - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - }, - "descriptionHTML": "

Page number of the results to fetch.

" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/events", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/events
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/events', {\n org: 'org'\n})", - "html": "
await octokit.request('GET /orgs/{org}/events', {\n  org: 'org'\n})\n
" - } - ], - "summary": "List public organization events", - "description": "", - "tags": [ - "activity" - ], - "operationId": "activity/list-public-org-events", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#list-public-organization-events" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "activity", - "subcategory": "events" - }, - "slug": "list-public-organization-events", - "category": "activity", - "categoryLabel": "Activity", - "subcategory": "events", - "subcategoryLabel": "Events", - "notes": [], - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response" - } - ], - "bodyParameters": [], - "descriptionHTML": "" - }, - { - "verb": "get", - "requestPath": "/orgs/{org}/hooks", + "requestPath": "/orgs/{org}/teams", "serverUrl": "https://api.github.com", "parameters": [ { @@ -10998,57 +18551,55 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/hooks', {\n org: 'org'\n})", - "html": "
await octokit.request('GET /orgs/{org}/hooks', {\n  org: 'org'\n})\n
" + "source": "await octokit.request('GET /orgs/{org}/teams', {\n org: 'org'\n})", + "html": "
await octokit.request('GET /orgs/{org}/teams', {\n  org: 'org'\n})\n
" } ], - "summary": "List organization webhooks", - "description": "", + "summary": "List teams", + "description": "Lists all teams in an organization that are visible to the authenticated user.", "tags": [ - "orgs" + "teams" ], - "operationId": "orgs/list-webhooks", + "operationId": "teams/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#list-organization-webhooks" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#list-teams" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "category": "orgs", - "subcategory": "webhooks" + "category": "teams", + "subcategory": null }, - "slug": "list-organization-webhooks", - "category": "orgs", - "categoryLabel": "Orgs", - "subcategory": "webhooks", - "subcategoryLabel": "Webhooks", + "slug": "list-teams", + "category": "teams", + "categoryLabel": "Teams", "notes": [], "bodyParameters": [], - "descriptionHTML": "", + "descriptionHTML": "

Lists all teams in an organization that are visible to the authenticated user.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"id\": 1,\n    \"url\": \"https://api.github.com/orgs/octocat/hooks/1\",\n    \"ping_url\": \"https://api.github.com/orgs/octocat/hooks/1/pings\",\n    \"name\": \"web\",\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ],\n    \"active\": true,\n    \"config\": {\n      \"url\": \"http://example.com\",\n      \"content_type\": \"json\"\n    },\n    \"updated_at\": \"2011-09-06T20:39:23Z\",\n    \"created_at\": \"2011-09-06T17:26:27Z\",\n    \"type\": \"Organization\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
" }, { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" } ] }, { "verb": "post", - "requestPath": "/orgs/{org}/hooks", + "requestPath": "/orgs/{org}/teams", "serverUrl": "https://api.github.com", "parameters": [ { @@ -11064,24 +18615,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks \\\n -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks \\\n  -d '{\"name\":\"name\",\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\",\"username\":\"username\",\"password\":\"password\"}}'
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams \\\n -d '{\"name\":\"name\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams \\\n  -d '{\"name\":\"name\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /orgs/{org}/hooks', {\n org: 'org',\n name: 'name',\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl',\n username: 'username',\n password: 'password'\n }\n})", - "html": "
await octokit.request('POST /orgs/{org}/hooks', {\n  org: 'org',\n  name: 'name',\n  config: {\n    url: 'url',\n    content_type: 'content_type',\n    secret: 'secret',\n    insecure_ssl: 'insecure_ssl',\n    username: 'username',\n    password: 'password'\n  }\n})\n
" + "source": "await octokit.request('POST /orgs/{org}/teams', {\n org: 'org',\n name: 'name'\n})", + "html": "
await octokit.request('POST /orgs/{org}/teams', {\n  org: 'org',\n  name: 'name'\n})\n
" } ], - "summary": "Create an organization webhook", - "description": "Here's how you can create a hook that posts payloads in JSON format:", + "summary": "Create a team", + "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", "tags": [ - "orgs" + "teams" ], - "operationId": "orgs/create-webhook", + "operationId": "teams/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#create-an-organization-webhook" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#create-a-team" }, "requestBody": { "content": { @@ -11091,195 +18642,93 @@ "properties": { "name": { "type": "string", - "description": "

Required. Must be passed as \"web\".

", + "description": "

Required. The name of the team.

", "name": "name", "in": "body", "rawType": "string", - "rawDescription": "Must be passed as \"web\".", + "rawDescription": "The name of the team.", "childParamsGroups": [] }, - "config": { - "type": "object", - "description": "

Required. Key/value pairs to provide settings for this webhook. These are defined below.

", - "properties": { - "url": { - "type": "string", - "description": "

Required. The URL to which the payloads will be delivered.

", - "example": "https://example.com/webhook", - "format": "uri", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", - "example": "\"json\"", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

", - "example": "\"********\"", - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "childParamsGroups": [] - }, - "insecure_ssl": { - "type": "string", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "example": "\"0\"", - "name": "insecure_ssl", - "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "childParamsGroups": [] - }, - "username": { - "type": "string", - "example": "\"kdaigle\"", - "name": "username", - "in": "body", - "rawType": "string", - "description": "

undefined

", - "childParamsGroups": [] - }, - "password": { - "type": "string", - "example": "\"password\"", - "name": "password", - "in": "body", - "rawType": "string", - "description": "

undefined

", - "childParamsGroups": [] - } + "description": { + "type": "string", + "description": "

The description of the team.

", + "name": "description", + "in": "body", + "rawType": "string", + "rawDescription": "The description of the team.", + "childParamsGroups": [] + }, + "maintainers": { + "type": "array of strings", + "description": "

List GitHub IDs for organization members who will become team maintainers.

", + "items": { + "type": "string" }, - "required": [ - "url" - ], - "name": "config", + "name": "maintainers", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/github-ae@latest/rest/reference/orgs#create-hook-config-params).", - "childParamsGroups": [ - { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

Required. The URL to which the payloads will be delivered.

", - "example": "https://example.com/webhook", - "format": "uri", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", - "example": "\"json\"", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

", - "example": "\"********\"", - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "example": "\"0\"", - "name": "insecure_ssl", - "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "childParamsGroups": [] - }, - { - "type": "string", - "example": "\"kdaigle\"", - "name": "username", - "in": "body", - "rawType": "string", - "description": "

undefined

", - "childParamsGroups": [] - }, - { - "type": "string", - "example": "\"password\"", - "name": "password", - "in": "body", - "rawType": "string", - "description": "

undefined

", - "childParamsGroups": [] - } - ] - } - ] + "rawType": "array", + "rawDescription": "List GitHub IDs for organization members who will become team maintainers.", + "childParamsGroups": [] }, - "events": { + "repo_names": { "type": "array of strings", - "description": "

Determines what events the hook is triggered for.

", - "default": [ - "push" - ], + "description": "

The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

", "items": { "type": "string" }, - "name": "events", + "name": "repo_names", "in": "body", "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) the hook is triggered for.", + "rawDescription": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", "childParamsGroups": [] }, - "active": { - "type": "boolean", - "description": "

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

", - "default": true, - "name": "active", + "privacy": { + "type": "string", + "description": "

The level of privacy this team should have. The options are:
\nFor a non-nested team:
\n* secret - only visible to organization owners and members of this team.
\n* closed - visible to all members of this organization.
\nDefault: secret
\nFor a parent or child team:
\n* closed - visible to all members of this organization.
\nDefault for child team: closed

", + "enum": [ + "secret", + "closed" + ], + "name": "privacy", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "rawType": "string", + "rawDescription": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", + "childParamsGroups": [] + }, + "permission": { + "type": "string", + "description": "

Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of:
\n* pull - team members can pull, but not push to or administer newly-added repositories.
\n* push - team members can pull and push, but not administer newly-added repositories.
\n* admin - team members can pull, push and administer newly-added repositories.

", + "enum": [ + "pull", + "push", + "admin" + ], + "default": "pull", + "name": "permission", + "in": "body", + "rawType": "string", + "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", + "childParamsGroups": [] + }, + "parent_team_id": { + "type": "integer", + "description": "

The ID of a team to set as the parent team.

", + "name": "parent_team_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of a team to set as the parent team.", "childParamsGroups": [] } }, "required": [ - "name", - "config" + "name" ] }, "example": { - "name": "web", - "active": true, - "events": [ - "push", - "pull_request" - ], - "config": { - "url": "http://example.com/webhook", - "content_type": "json" - } + "name": "Justice League", + "description": "A great team", + "permission": "admin", + "privacy": "closed" } } } @@ -11288,214 +18737,457 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "category": "orgs", - "subcategory": "webhooks" + "category": "teams", + "subcategory": null + }, + "slug": "create-a-team", + "category": "teams", + "categoryLabel": "Teams", + "notes": [], + "descriptionHTML": "

To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"Setting team creation permissions.\"

\n

When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see \"About teams\".

", + "bodyParameters": [ + { + "type": "string", + "description": "

Required. The name of the team.

", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the team.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The description of the team.

", + "name": "description", + "in": "body", + "rawType": "string", + "rawDescription": "The description of the team.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

List GitHub IDs for organization members who will become team maintainers.

", + "items": { + "type": "string" + }, + "name": "maintainers", + "in": "body", + "rawType": "array", + "rawDescription": "List GitHub IDs for organization members who will become team maintainers.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

", + "items": { + "type": "string" + }, + "name": "repo_names", + "in": "body", + "rawType": "array", + "rawDescription": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The level of privacy this team should have. The options are:
\nFor a non-nested team:
\n* secret - only visible to organization owners and members of this team.
\n* closed - visible to all members of this organization.
\nDefault: secret
\nFor a parent or child team:
\n* closed - visible to all members of this organization.
\nDefault for child team: closed

", + "enum": [ + "secret", + "closed" + ], + "name": "privacy", + "in": "body", + "rawType": "string", + "rawDescription": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of:
\n* pull - team members can pull, but not push to or administer newly-added repositories.
\n* push - team members can pull and push, but not administer newly-added repositories.
\n* admin - team members can pull, push and administer newly-added repositories.

", + "enum": [ + "pull", + "push", + "admin" + ], + "default": "pull", + "name": "permission", + "in": "body", + "rawType": "string", + "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The ID of a team to set as the parent team.

", + "name": "parent_team_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of a team to set as the parent team.", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Default response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDQ6VGVhbTE=\",\n  \"url\": \"https://api.github.com/teams/1\",\n  \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n  \"name\": \"Justice League\",\n  \"slug\": \"justice-league\",\n  \"description\": \"A great team.\",\n  \"privacy\": \"closed\",\n  \"permission\": \"admin\",\n  \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n  \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n  \"parent\": null,\n  \"members_count\": 3,\n  \"repos_count\": 10,\n  \"created_at\": \"2017-07-14T16:53:42Z\",\n  \"updated_at\": \"2017-08-17T12:37:15Z\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\",\n    \"name\": \"github\",\n    \"company\": \"GitHub\",\n    \"blog\": \"https://github.com/blog\",\n    \"location\": \"San Francisco\",\n    \"email\": \"octocat@github.com\",\n    \"is_verified\": true,\n    \"has_organization_projects\": true,\n    \"has_repository_projects\": true,\n    \"public_repos\": 2,\n    \"public_gists\": 1,\n    \"followers\": 20,\n    \"following\": 0,\n    \"html_url\": \"https://github.com/octocat\",\n    \"created_at\": \"2008-01-14T04:33:35Z\",\n    \"updated_at\": \"2017-08-17T12:37:15Z\",\n    \"type\": \"Organization\"\n  }\n}\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, + { + "verb": "get", + "requestPath": "/orgs/{org}/teams/{team_slug}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

team_slug parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}', {\n org: 'org',\n team_slug: 'team_slug'\n})", + "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}', {\n  org: 'org',\n  team_slug: 'team_slug'\n})\n
" + } + ], + "summary": "Get a team by name", + "description": "Gets a team using the team's `slug`. GitHub AE generates the `slug` from the team `name`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", + "tags": [ + "teams" + ], + "operationId": "teams/get-by-name", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#get-a-team-by-name" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": null }, - "slug": "create-an-organization-webhook", - "category": "orgs", - "categoryLabel": "Orgs", - "subcategory": "webhooks", - "subcategoryLabel": "Webhooks", + "slug": "get-a-team-by-name", + "category": "teams", + "categoryLabel": "Teams", "notes": [], - "descriptionHTML": "

Here's how you can create a hook that posts payloads in JSON format:

", + "bodyParameters": [], + "descriptionHTML": "

Gets a team using the team's slug. GitHub AE generates the slug from the team name.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.

", "responses": [ { - "httpStatusCode": "201", - "httpStatusMessage": "Created", + "httpStatusCode": "200", + "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"id\": 1,\n  \"url\": \"https://api.github.com/orgs/octocat/hooks/1\",\n  \"ping_url\": \"https://api.github.com/orgs/octocat/hooks/1/pings\",\n  \"name\": \"web\",\n  \"events\": [\n    \"push\",\n    \"pull_request\"\n  ],\n  \"active\": true,\n  \"config\": {\n    \"url\": \"http://example.com\",\n    \"content_type\": \"json\"\n  },\n  \"updated_at\": \"2011-09-06T20:39:23Z\",\n  \"created_at\": \"2011-09-06T17:26:27Z\",\n  \"type\": \"Organization\"\n}\n
" + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDQ6VGVhbTE=\",\n  \"url\": \"https://api.github.com/teams/1\",\n  \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n  \"name\": \"Justice League\",\n  \"slug\": \"justice-league\",\n  \"description\": \"A great team.\",\n  \"privacy\": \"closed\",\n  \"permission\": \"admin\",\n  \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n  \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n  \"parent\": null,\n  \"members_count\": 3,\n  \"repos_count\": 10,\n  \"created_at\": \"2017-07-14T16:53:42Z\",\n  \"updated_at\": \"2017-08-17T12:37:15Z\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\",\n    \"name\": \"github\",\n    \"company\": \"GitHub\",\n    \"blog\": \"https://github.com/blog\",\n    \"location\": \"San Francisco\",\n    \"email\": \"octocat@github.com\",\n    \"is_verified\": true,\n    \"has_organization_projects\": true,\n    \"has_repository_projects\": true,\n    \"public_repos\": 2,\n    \"public_gists\": 1,\n    \"followers\": 20,\n    \"following\": 0,\n    \"html_url\": \"https://github.com/octocat\",\n    \"created_at\": \"2008-01-14T04:33:35Z\",\n    \"updated_at\": \"2017-08-17T12:37:15Z\",\n    \"type\": \"Organization\"\n  }\n}\n
" }, { "httpStatusCode": "404", "httpStatusMessage": "Not Found", "description": "Resource not found" + } + ] + }, + { + "verb": "patch", + "requestPath": "/orgs/{org}/teams/{team_slug}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" }, { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

team_slug parameter

" } ], - "bodyParameters": [ + "x-codeSamples": [ { - "type": "string", - "description": "

Required. Must be passed as \"web\".

", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "Must be passed as \"web\".", - "childParamsGroups": [] + "lang": "Shell", + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG \\\n -d '{\"name\":\"name\"}'", + "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG \\\n  -d '{\"name\":\"name\"}'
" }, { - "type": "object", - "description": "

Required. Key/value pairs to provide settings for this webhook. These are defined below.

", - "properties": { - "url": { - "type": "string", - "description": "

Required. The URL to which the payloads will be delivered.

", - "example": "https://example.com/webhook", - "format": "uri", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", - "example": "\"json\"", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

", - "example": "\"********\"", - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "childParamsGroups": [] - }, - "insecure_ssl": { - "type": "string", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "example": "\"0\"", - "name": "insecure_ssl", - "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "childParamsGroups": [] - }, - "username": { - "type": "string", - "example": "\"kdaigle\"", - "name": "username", - "in": "body", - "rawType": "string", - "description": "

undefined

", - "childParamsGroups": [] - }, - "password": { - "type": "string", - "example": "\"password\"", - "name": "password", - "in": "body", - "rawType": "string", - "description": "

undefined

", - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], - "name": "config", - "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/github-ae@latest/rest/reference/orgs#create-hook-config-params).", - "childParamsGroups": [ - { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

Required. The URL to which the payloads will be delivered.

", - "example": "https://example.com/webhook", - "format": "uri", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] - }, - { + "lang": "JavaScript", + "source": "await octokit.request('PATCH /orgs/{org}/teams/{team_slug}', {\n org: 'org',\n team_slug: 'team_slug',\n name: 'name'\n})", + "html": "
await octokit.request('PATCH /orgs/{org}/teams/{team_slug}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  name: 'name'\n})\n
" + } + ], + "summary": "Update a team", + "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", + "tags": [ + "teams" + ], + "operationId": "teams/update-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#update-a-team" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { "type": "string", - "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", - "example": "\"json\"", - "name": "content_type", + "description": "

The name of the team.

", + "name": "name", "in": "body", "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "rawDescription": "The name of the team.", "childParamsGroups": [] }, - { + "description": { "type": "string", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

", - "example": "\"********\"", - "name": "secret", + "description": "

The description of the team.

", + "name": "description", "in": "body", "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "rawDescription": "The description of the team.", "childParamsGroups": [] }, - { + "privacy": { "type": "string", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "example": "\"0\"", - "name": "insecure_ssl", + "description": "

The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
\n* secret - only visible to organization owners and members of this team.
\n* closed - visible to all members of this organization.
\nFor a parent or child team:
\n* closed - visible to all members of this organization.

", + "enum": [ + "secret", + "closed" + ], + "name": "privacy", "in": "body", "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "rawDescription": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", "childParamsGroups": [] }, - { + "permission": { "type": "string", - "example": "\"kdaigle\"", - "name": "username", + "description": "

Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of:
\n* pull - team members can pull, but not push to or administer newly-added repositories.
\n* push - team members can pull and push, but not administer newly-added repositories.
\n* admin - team members can pull, push and administer newly-added repositories.

", + "enum": [ + "pull", + "push", + "admin" + ], + "default": "pull", + "name": "permission", "in": "body", "rawType": "string", - "description": "

undefined

", + "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", "childParamsGroups": [] }, - { - "type": "string", - "example": "\"password\"", - "name": "password", + "parent_team_id": { + "type": "integer or null", + "description": "

The ID of a team to set as the parent team.

", + "nullable": true, + "name": "parent_team_id", "in": "body", - "rawType": "string", - "description": "

undefined

", + "rawType": "integer", + "rawDescription": "The ID of a team to set as the parent team.", "childParamsGroups": [] } - ] + } + }, + "example": { + "name": "new team name", + "description": "new team description", + "privacy": "closed" } - ] + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": null + }, + "slug": "update-a-team", + "category": "teams", + "categoryLabel": "Teams", + "notes": [], + "descriptionHTML": "

To edit a team, the authenticated user must either be an organization owner or a team maintainer.

\n

Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.

", + "bodyParameters": [ + { + "type": "string", + "description": "

The name of the team.

", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the team.", + "childParamsGroups": [] }, { - "type": "array of strings", - "description": "

Determines what events the hook is triggered for.

", - "default": [ - "push" + "type": "string", + "description": "

The description of the team.

", + "name": "description", + "in": "body", + "rawType": "string", + "rawDescription": "The description of the team.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
\n* secret - only visible to organization owners and members of this team.
\n* closed - visible to all members of this organization.
\nFor a parent or child team:
\n* closed - visible to all members of this organization.

", + "enum": [ + "secret", + "closed" ], - "items": { - "type": "string" - }, - "name": "events", + "name": "privacy", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) the hook is triggered for.", + "rawType": "string", + "rawDescription": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", "childParamsGroups": [] }, { - "type": "boolean", - "description": "

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

", - "default": true, - "name": "active", + "type": "string", + "description": "

Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of:
\n* pull - team members can pull, but not push to or administer newly-added repositories.
\n* push - team members can pull and push, but not administer newly-added repositories.
\n* admin - team members can pull, push and administer newly-added repositories.

", + "enum": [ + "pull", + "push", + "admin" + ], + "default": "pull", + "name": "permission", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "rawType": "string", + "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", + "childParamsGroups": [] + }, + { + "type": "integer or null", + "description": "

The ID of a team to set as the parent team.

", + "nullable": true, + "name": "parent_team_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The ID of a team to set as the parent team.", "childParamsGroups": [] } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Default response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDQ6VGVhbTE=\",\n  \"url\": \"https://api.github.com/teams/1\",\n  \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n  \"name\": \"Justice League\",\n  \"slug\": \"justice-league\",\n  \"description\": \"A great team.\",\n  \"privacy\": \"closed\",\n  \"permission\": \"admin\",\n  \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n  \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n  \"parent\": null,\n  \"members_count\": 3,\n  \"repos_count\": 10,\n  \"created_at\": \"2017-07-14T16:53:42Z\",\n  \"updated_at\": \"2017-08-17T12:37:15Z\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\",\n    \"name\": \"github\",\n    \"company\": \"GitHub\",\n    \"blog\": \"https://github.com/blog\",\n    \"location\": \"San Francisco\",\n    \"email\": \"octocat@github.com\",\n    \"is_verified\": true,\n    \"has_organization_projects\": true,\n    \"has_repository_projects\": true,\n    \"public_repos\": 2,\n    \"public_gists\": 1,\n    \"followers\": 20,\n    \"following\": 0,\n    \"html_url\": \"https://github.com/octocat\",\n    \"created_at\": \"2008-01-14T04:33:35Z\",\n    \"updated_at\": \"2017-08-17T12:37:15Z\",\n    \"type\": \"Organization\"\n  }\n}\n
" + } ] }, + { + "verb": "delete", + "requestPath": "/orgs/{org}/teams/{team_slug}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

team_slug parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /orgs/{org}/teams/{team_slug}', {\n org: 'org',\n team_slug: 'team_slug'\n})", + "html": "
await octokit.request('DELETE /orgs/{org}/teams/{team_slug}', {\n  org: 'org',\n  team_slug: 'team_slug'\n})\n
" + } + ], + "summary": "Delete a team", + "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", + "tags": [ + "teams" + ], + "operationId": "teams/delete-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#delete-a-team" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": null + }, + "slug": "delete-a-team", + "category": "teams", + "categoryLabel": "Teams", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

To delete a team, the authenticated user must be an organization owner or team maintainer.

\n

If you are an organization owner, deleting a parent team will delete all of its child teams as well.

\n

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.

" + }, { "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}", + "requestPath": "/orgs/{org}/teams/{team_slug}/discussions", "serverUrl": "https://api.github.com", "parameters": [ { @@ -11503,74 +19195,112 @@ "in": "path", "required": true, "schema": { - "type": "string" + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

team_slug parameter

" + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

One of asc (ascending) or desc (descending).

" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 }, - "descriptionHTML": "" + "descriptionHTML": "

Results per page (max 100).

" }, { - "name": "hook_id", - "in": "path", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", "schema": { - "type": "integer" + "type": "integer", + "default": 1 }, - "descriptionHTML": "" + "descriptionHTML": "

Page number of the results to fetch.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/hooks/{hook_id}', {\n org: 'org',\n hook_id: 42\n})", - "html": "
await octokit.request('GET /orgs/{org}/hooks/{hook_id}', {\n  org: 'org',\n  hook_id: 42\n})\n
" + "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions', {\n org: 'org',\n team_slug: 'team_slug'\n})", + "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions', {\n  org: 'org',\n  team_slug: 'team_slug'\n})\n
" } ], - "summary": "Get an organization webhook", - "description": "Returns a webhook configured in an organization. To get only the webhook `config` properties, see \"[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization).\"", + "summary": "List discussions", + "description": "List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.", "tags": [ - "orgs" + "teams" ], - "operationId": "orgs/get-webhook", + "operationId": "teams/list-discussions-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#get-an-organization-webhook" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#list-discussions" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "webhooks" + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", + "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + } + ], + "category": "teams", + "subcategory": "discussions" }, - "slug": "get-an-organization-webhook", - "category": "orgs", - "categoryLabel": "Orgs", - "subcategory": "webhooks", - "subcategoryLabel": "Webhooks", + "slug": "list-discussions", + "category": "teams", + "categoryLabel": "Teams", + "subcategory": "discussions", + "subcategoryLabel": "Discussions", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Returns a webhook configured in an organization. To get only the webhook config properties, see \"Get a webhook configuration for an organization.\"

", + "descriptionHTML": "

List all discussions on a team's page. OAuth access tokens require the read:discussion scope.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"id\": 1,\n  \"url\": \"https://api.github.com/orgs/octocat/hooks/1\",\n  \"ping_url\": \"https://api.github.com/orgs/octocat/hooks/1/pings\",\n  \"name\": \"web\",\n  \"events\": [\n    \"push\",\n    \"pull_request\"\n  ],\n  \"active\": true,\n  \"config\": {\n    \"url\": \"http://example.com\",\n    \"content_type\": \"json\"\n  },\n  \"updated_at\": \"2011-09-06T20:39:23Z\",\n  \"created_at\": \"2011-09-06T17:26:27Z\",\n  \"type\": \"Organization\"\n}\n
" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "payload": "
[\n  {\n    \"author\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"body\": \"Hi! This is an area for us to collaborate as a team.\",\n    \"body_html\": \"<p>Hi! This is an area for us to collaborate as a team</p>\",\n    \"body_version\": \"0d495416a700fb06133c612575d92bfb\",\n    \"comments_count\": 0,\n    \"comments_url\": \"https://api.github.com/teams/2343027/discussions/1/comments\",\n    \"created_at\": \"2018-01-25T18:56:31Z\",\n    \"last_edited_at\": null,\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1\",\n    \"node_id\": \"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\n    \"number\": 1,\n    \"pinned\": false,\n    \"private\": false,\n    \"team_url\": \"https://api.github.com/teams/2343027\",\n    \"title\": \"Our first team post\",\n    \"updated_at\": \"2018-01-25T18:56:31Z\",\n    \"url\": \"https://api.github.com/teams/2343027/discussions/1\",\n    \"reactions\": {\n      \"url\": \"https://api.github.com/teams/2343027/discussions/1/reactions\",\n      \"total_count\": 5,\n      \"+1\": 3,\n      \"-1\": 1,\n      \"laugh\": 0,\n      \"confused\": 0,\n      \"heart\": 1,\n      \"hooray\": 0,\n      \"eyes\": 1,\n      \"rocket\": 1\n    }\n  }\n]\n
" } ] }, { - "verb": "patch", - "requestPath": "/orgs/{org}/hooks/{hook_id}", + "verb": "post", + "requestPath": "/orgs/{org}/teams/{team_slug}/discussions", "serverUrl": "https://api.github.com", "parameters": [ { @@ -11583,36 +19313,37 @@ "descriptionHTML": "" }, { - "name": "hook_id", + "name": "team_slug", + "description": "team_slug parameter", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" }, - "descriptionHTML": "" + "descriptionHTML": "

team_slug parameter

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42 \\\n -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'", - "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42 \\\n  -d '{\"config\":{\"url\":\"url\",\"content_type\":\"content_type\",\"secret\":\"secret\",\"insecure_ssl\":\"insecure_ssl\"}}'
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PATCH /orgs/{org}/hooks/{hook_id}', {\n org: 'org',\n hook_id: 42,\n config: {\n url: 'url',\n content_type: 'content_type',\n secret: 'secret',\n insecure_ssl: 'insecure_ssl'\n }\n})", - "html": "
await octokit.request('PATCH /orgs/{org}/hooks/{hook_id}', {\n  org: 'org',\n  hook_id: 42,\n  config: {\n    url: 'url',\n    content_type: 'content_type',\n    secret: 'secret',\n    insecure_ssl: 'insecure_ssl'\n  }\n})\n
" + "source": "await octokit.request('POST /orgs/{org}/teams/{team_slug}/discussions', {\n org: 'org',\n team_slug: 'team_slug',\n title: 'title',\n body: 'body'\n})", + "html": "
await octokit.request('POST /orgs/{org}/teams/{team_slug}/discussions', {\n  org: 'org',\n  team_slug: 'team_slug',\n  title: 'title',\n  body: 'body'\n})\n
" } ], - "summary": "Update an organization webhook", - "description": "Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization).\"", + "summary": "Create a discussion", + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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 abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", "tags": [ - "orgs" + "teams" ], - "operationId": "orgs/update-webhook", + "operationId": "teams/create-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#update-an-organization-webhook" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-discussion" }, "requestBody": { "content": { @@ -11620,405 +19351,111 @@ "schema": { "type": "object", "properties": { - "config": { - "type": "object", - "description": "

Key/value pairs to provide settings for this webhook. These are defined below.

", - "properties": { - "url": { - "type": "string", - "description": "

Required. The URL to which the payloads will be delivered.

", - "example": "https://example.com/webhook", - "format": "uri", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", - "example": "\"json\"", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

", - "example": "\"********\"", - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "childParamsGroups": [] - }, - "insecure_ssl": { - "type": "string", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "example": "\"0\"", - "name": "insecure_ssl", - "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], - "name": "config", + "title": { + "type": "string", + "description": "

Required. The discussion post's title.

", + "name": "title", "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/github-ae@latest/rest/reference/orgs#update-hook-config-params).", - "childParamsGroups": [ - { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

Required. The URL to which the payloads will be delivered.

", - "example": "https://example.com/webhook", - "format": "uri", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", - "example": "\"json\"", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

", - "example": "\"********\"", - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "example": "\"0\"", - "name": "insecure_ssl", - "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "childParamsGroups": [] - } - ] - } - ] + "rawType": "string", + "rawDescription": "The discussion post's title.", + "childParamsGroups": [] }, - "events": { - "type": "array of strings", - "description": "

Determines what events the hook is triggered for.

", - "default": [ - "push" - ], - "items": { - "type": "string" - }, - "name": "events", + "body": { + "type": "string", + "description": "

Required. The discussion post's body text.

", + "name": "body", "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) the hook is triggered for.", + "rawType": "string", + "rawDescription": "The discussion post's body text.", "childParamsGroups": [] }, - "active": { + "private": { "type": "boolean", - "description": "

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

", - "default": true, - "name": "active", + "description": "

Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

", + "default": false, + "name": "private", "in": "body", "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "childParamsGroups": [] - }, - "name": { - "type": "string", - "example": "\"web\"", - "name": "name", - "in": "body", - "rawType": "string", - "description": "

undefined

", + "rawDescription": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", "childParamsGroups": [] } - } + }, + "required": [ + "title", + "body" + ] }, "example": { - "active": true, - "events": [ - "pull_request" - ] + "title": "Our first team post", + "body": "Hi! This is an area for us to collaborate as a team." } } } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "webhooks" + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", + "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + } + ], + "category": "teams", + "subcategory": "discussions" }, - "slug": "update-an-organization-webhook", - "category": "orgs", - "categoryLabel": "Orgs", - "subcategory": "webhooks", - "subcategoryLabel": "Webhooks", + "slug": "create-a-discussion", + "category": "teams", + "categoryLabel": "Teams", + "subcategory": "discussions", + "subcategoryLabel": "Discussions", "notes": [], - "descriptionHTML": "

Updates a webhook configured in an organization. When you update a webhook, the secret will be overwritten. If you previously had a secret set, you must provide the same secret or set a new secret or the secret will be removed. If you are only updating individual webhook config properties, use \"Update a webhook configuration for an organization.\"

", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Default response", - "payload": "
{\n  \"id\": 1,\n  \"url\": \"https://api.github.com/orgs/octocat/hooks/1\",\n  \"ping_url\": \"https://api.github.com/orgs/octocat/hooks/1/pings\",\n  \"name\": \"web\",\n  \"events\": [\n    \"pull_request\"\n  ],\n  \"active\": true,\n  \"config\": {\n    \"url\": \"http://example.com\",\n    \"content_type\": \"json\"\n  },\n  \"updated_at\": \"2011-09-06T20:39:23Z\",\n  \"created_at\": \"2011-09-06T17:26:27Z\",\n  \"type\": \"Organization\"\n}\n
" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ], + "descriptionHTML": "

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.

", "bodyParameters": [ { - "type": "object", - "description": "

Key/value pairs to provide settings for this webhook. These are defined below.

", - "properties": { - "url": { - "type": "string", - "description": "

Required. The URL to which the payloads will be delivered.

", - "example": "https://example.com/webhook", - "format": "uri", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", - "example": "\"json\"", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] - }, - "secret": { - "type": "string", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

", - "example": "\"********\"", - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "childParamsGroups": [] - }, - "insecure_ssl": { - "type": "string", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "example": "\"0\"", - "name": "insecure_ssl", - "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "childParamsGroups": [] - } - }, - "required": [ - "url" - ], - "name": "config", - "in": "body", - "rawType": "object", - "rawDescription": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/github-ae@latest/rest/reference/orgs#update-hook-config-params).", - "childParamsGroups": [ - { - "parentName": "config", - "parentType": "object", - "id": "config-object", - "params": [ - { - "type": "string", - "description": "

Required. The URL to which the payloads will be delivered.

", - "example": "https://example.com/webhook", - "format": "uri", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", - "example": "\"json\"", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

", - "example": "\"********\"", - "name": "secret", - "in": "body", - "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "example": "\"0\"", - "name": "insecure_ssl", - "in": "body", - "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "childParamsGroups": [] - } - ] - } - ] - }, - { - "type": "array of strings", - "description": "

Determines what events the hook is triggered for.

", - "default": [ - "push" - ], - "items": { - "type": "string" - }, - "name": "events", - "in": "body", - "rawType": "array", - "rawDescription": "Determines what [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) the hook is triggered for.", - "childParamsGroups": [] - }, - { - "type": "boolean", - "description": "

Determines if notifications are sent when the webhook is triggered. Set to true to send notifications.

", - "default": true, - "name": "active", + "type": "string", + "description": "

Required. The discussion post's title.

", + "name": "title", "in": "body", - "rawType": "boolean", - "rawDescription": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "rawType": "string", + "rawDescription": "The discussion post's title.", "childParamsGroups": [] }, { "type": "string", - "example": "\"web\"", - "name": "name", + "description": "

Required. The discussion post's body text.

", + "name": "body", "in": "body", "rawType": "string", - "description": "

undefined

", + "rawDescription": "The discussion post's body text.", "childParamsGroups": [] - } - ] - }, - { - "verb": "delete", - "requestPath": "/orgs/{org}/hooks/{hook_id}", - "serverUrl": "https://api.github.com", - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "hook_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('DELETE /orgs/{org}/hooks/{hook_id}', {\n org: 'org',\n hook_id: 42\n})", - "html": "
await octokit.request('DELETE /orgs/{org}/hooks/{hook_id}', {\n  org: 'org',\n  hook_id: 42\n})\n
" - } - ], - "summary": "Delete an organization webhook", - "description": "", - "tags": [ - "orgs" - ], - "operationId": "orgs/delete-webhook", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#delete-an-organization-webhook" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "webhooks" - }, - "slug": "delete-an-organization-webhook", - "category": "orgs", - "categoryLabel": "Orgs", - "subcategory": "webhooks", - "subcategoryLabel": "Webhooks", - "notes": [], - "responses": [ - { - "httpStatusCode": "204", - "httpStatusMessage": "No Content", - "description": "Default Response" }, { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "type": "boolean", + "description": "

Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

", + "default": false, + "name": "private", + "in": "body", + "rawType": "boolean", + "rawDescription": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", + "childParamsGroups": [] } ], - "bodyParameters": [], - "descriptionHTML": "" + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Default response", + "payload": "
{\n  \"author\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"body\": \"Hi! This is an area for us to collaborate as a team.\",\n  \"body_html\": \"<p>Hi! This is an area for us to collaborate as a team</p>\",\n  \"body_version\": \"0d495416a700fb06133c612575d92bfb\",\n  \"comments_count\": 0,\n  \"comments_url\": \"https://api.github.com/teams/2343027/discussions/1/comments\",\n  \"created_at\": \"2018-01-25T18:56:31Z\",\n  \"last_edited_at\": null,\n  \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1\",\n  \"node_id\": \"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\n  \"number\": 1,\n  \"pinned\": false,\n  \"private\": false,\n  \"team_url\": \"https://api.github.com/teams/2343027\",\n  \"title\": \"Our first team post\",\n  \"updated_at\": \"2018-01-25T18:56:31Z\",\n  \"url\": \"https://api.github.com/teams/2343027/discussions/1\",\n  \"reactions\": {\n    \"url\": \"https://api.github.com/teams/2343027/discussions/1/reactions\",\n    \"total_count\": 5,\n    \"+1\": 3,\n    \"-1\": 1,\n    \"laugh\": 0,\n    \"confused\": 0,\n    \"heart\": 1,\n    \"hooray\": 0,\n    \"eyes\": 1,\n    \"rocket\": 1\n  }\n}\n
" + } + ] }, { "verb": "get", - "requestPath": "/orgs/{org}/hooks/{hook_id}/config", + "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", "serverUrl": "https://api.github.com", "parameters": [ { @@ -12031,7 +19468,17 @@ "descriptionHTML": "" }, { - "name": "hook_id", + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

team_slug parameter

" + }, + { + "name": "discussion_number", "in": "path", "required": true, "schema": { @@ -12043,52 +19490,59 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42/config", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42/config
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/hooks/{hook_id}/config', {\n org: 'org',\n hook_id: 42\n})", - "html": "
await octokit.request('GET /orgs/{org}/hooks/{hook_id}/config', {\n  org: 'org',\n  hook_id: 42\n})\n
" + "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42\n})", + "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42\n})\n
" } ], - "summary": "Get a webhook configuration for an organization", - "description": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook).\"\n\nAccess tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission.", + "summary": "Get a discussion", + "description": "Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.", "tags": [ - "orgs" + "teams" ], - "operationId": "orgs/get-webhook-config-for-org", + "operationId": "teams/get-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#get-a-webhook-configuration-for-an-organization" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#get-a-discussion" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "webhooks" + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", + "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + } + ], + "category": "teams", + "subcategory": "discussions" }, - "slug": "get-a-webhook-configuration-for-an-organization", - "category": "orgs", - "categoryLabel": "Orgs", - "subcategory": "webhooks", - "subcategoryLabel": "Webhooks", + "slug": "get-a-discussion", + "category": "teams", + "categoryLabel": "Teams", + "subcategory": "discussions", + "subcategoryLabel": "Discussions", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Returns the webhook configuration for an organization. To get more information about the webhook, including the active state and events, use \"Get an organization webhook .\"

\n

Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:read permission.

", + "descriptionHTML": "

Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" + "payload": "
{\n  \"author\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"body\": \"Hi! This is an area for us to collaborate as a team.\",\n  \"body_html\": \"<p>Hi! This is an area for us to collaborate as a team</p>\",\n  \"body_version\": \"0d495416a700fb06133c612575d92bfb\",\n  \"comments_count\": 0,\n  \"comments_url\": \"https://api.github.com/teams/2343027/discussions/1/comments\",\n  \"created_at\": \"2018-01-25T18:56:31Z\",\n  \"last_edited_at\": null,\n  \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1\",\n  \"node_id\": \"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\n  \"number\": 1,\n  \"pinned\": false,\n  \"private\": false,\n  \"team_url\": \"https://api.github.com/teams/2343027\",\n  \"title\": \"Our first team post\",\n  \"updated_at\": \"2018-01-25T18:56:31Z\",\n  \"url\": \"https://api.github.com/teams/2343027/discussions/1\",\n  \"reactions\": {\n    \"url\": \"https://api.github.com/teams/2343027/discussions/1/reactions\",\n    \"total_count\": 5,\n    \"+1\": 3,\n    \"-1\": 1,\n    \"laugh\": 0,\n    \"confused\": 0,\n    \"heart\": 1,\n    \"hooray\": 0,\n    \"eyes\": 1,\n    \"rocket\": 1\n  }\n}\n
" } ] }, { "verb": "patch", - "requestPath": "/orgs/{org}/hooks/{hook_id}/config", + "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", "serverUrl": "https://api.github.com", "parameters": [ { @@ -12101,7 +19555,17 @@ "descriptionHTML": "" }, { - "name": "hook_id", + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

team_slug parameter

" + }, + { + "name": "discussion_number", "in": "path", "required": true, "schema": { @@ -12113,24 +19577,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42/config \\\n -d '{\"url\":\"url\"}'", - "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42/config \\\n  -d '{\"url\":\"url\"}'
" + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42 \\\n -d '{\"title\":\"title\"}'", + "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42 \\\n  -d '{\"title\":\"title\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PATCH /orgs/{org}/hooks/{hook_id}/config', {\n org: 'org',\n hook_id: 42,\n url: 'url'\n})", - "html": "
await octokit.request('PATCH /orgs/{org}/hooks/{hook_id}/config', {\n  org: 'org',\n  hook_id: 42,\n  url: 'url'\n})\n
" + "source": "await octokit.request('PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n title: 'title'\n})", + "html": "
await octokit.request('PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  title: 'title'\n})\n
" } ], - "summary": "Update a webhook configuration for an organization", - "description": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook).\"\n\nAccess tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission.", + "summary": "Update a discussion", + "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.", "tags": [ - "orgs" + "teams" ], - "operationId": "orgs/update-webhook-config-for-org", + "operationId": "teams/update-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#update-a-webhook-configuration-for-an-organization" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#update-a-discussion" }, "requestBody": { "content": { @@ -12138,54 +19602,28 @@ "schema": { "type": "object", "properties": { - "url": { - "type": "string", - "description": "

The URL to which the payloads will be delivered.

", - "example": "https://example.com/webhook", - "format": "uri", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] - }, - "content_type": { - "type": "string", - "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", - "example": "\"json\"", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] - }, - "secret": { + "title": { "type": "string", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

", - "example": "\"********\"", - "name": "secret", + "description": "

The discussion post's title.

", + "name": "title", "in": "body", "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "rawDescription": "The discussion post's title.", "childParamsGroups": [] }, - "insecure_ssl": { + "body": { "type": "string", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "example": "\"0\"", - "name": "insecure_ssl", + "description": "

The discussion post's body text.

", + "name": "body", "in": "body", "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "rawDescription": "The discussion post's body text.", "childParamsGroups": [] } - }, - "example": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" } + }, + "example": { + "title": "Welcome to our first team post" } } } @@ -12193,57 +19631,41 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "webhooks" + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", + "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + } + ], + "category": "teams", + "subcategory": "discussions" }, - "slug": "update-a-webhook-configuration-for-an-organization", - "category": "orgs", - "categoryLabel": "Orgs", - "subcategory": "webhooks", - "subcategoryLabel": "Webhooks", + "slug": "update-a-discussion", + "category": "teams", + "categoryLabel": "Teams", + "subcategory": "discussions", + "subcategoryLabel": "Discussions", "notes": [], - "descriptionHTML": "

Updates the webhook configuration for an organization. To update more information about the webhook, including the active state and events, use \"Update an organization webhook .\"

\n

Access tokens must have the admin:org_hook scope, and GitHub Apps must have the organization_hooks:write permission.

", + "descriptionHTML": "

Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.

\n

Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.

", "bodyParameters": [ { "type": "string", - "description": "

The URL to which the payloads will be delivered.

", - "example": "https://example.com/webhook", - "format": "uri", - "name": "url", - "in": "body", - "rawType": "string", - "rawDescription": "The URL to which the payloads will be delivered.", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

The media type used to serialize the payloads. Supported values include json and form. The default is form.

", - "example": "\"json\"", - "name": "content_type", - "in": "body", - "rawType": "string", - "rawDescription": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

If provided, the secret will be used as the key to generate the HMAC hex digest value for delivery signature headers.

", - "example": "\"********\"", - "name": "secret", + "description": "

The discussion post's title.

", + "name": "title", "in": "body", "rawType": "string", - "rawDescription": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "rawDescription": "The discussion post's title.", "childParamsGroups": [] }, { "type": "string", - "description": "

Determines whether the SSL certificate of the host for url will be verified when delivering payloads. Supported values include 0 (verification is performed) and 1 (verification is not performed). The default is 0. We strongly recommend not setting this to 1 as you are subject to man-in-the-middle and other attacks.

", - "example": "\"0\"", - "name": "insecure_ssl", + "description": "

The discussion post's body text.

", + "name": "body", "in": "body", "rawType": "string", - "rawDescription": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "rawDescription": "The discussion post's body text.", "childParamsGroups": [] } ], @@ -12252,13 +19674,13 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"content_type\": \"json\",\n  \"insecure_ssl\": \"0\",\n  \"secret\": \"********\",\n  \"url\": \"https://example.com/webhook\"\n}\n
" + "payload": "
{\n  \"author\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"body\": \"Hi! This is an area for us to collaborate as a team.\",\n  \"body_html\": \"<p>Hi! This is an area for us to collaborate as a team</p>\",\n  \"body_version\": \"0d495416a700fb06133c612575d92bfb\",\n  \"comments_count\": 1,\n  \"comments_url\": \"https://api.github.com/teams/2343027/discussions/1/comments\",\n  \"created_at\": \"2018-01-25T18:56:31Z\",\n  \"last_edited_at\": \"2018-01-26T18:22:20Z\",\n  \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1\",\n  \"node_id\": \"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\n  \"number\": 1,\n  \"pinned\": false,\n  \"private\": false,\n  \"team_url\": \"https://api.github.com/teams/2343027\",\n  \"title\": \"Welcome to our first team post\",\n  \"updated_at\": \"2018-01-26T18:22:20Z\",\n  \"url\": \"https://api.github.com/teams/2343027/discussions/1\",\n  \"reactions\": {\n    \"url\": \"https://api.github.com/teams/2343027/discussions/1/reactions\",\n    \"total_count\": 5,\n    \"+1\": 3,\n    \"-1\": 1,\n    \"laugh\": 0,\n    \"confused\": 0,\n    \"heart\": 1,\n    \"hooray\": 0,\n    \"eyes\": 1,\n    \"rocket\": 1\n  }\n}\n
" } ] }, { - "verb": "post", - "requestPath": "/orgs/{org}/hooks/{hook_id}/pings", + "verb": "delete", + "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", "serverUrl": "https://api.github.com", "parameters": [ { @@ -12271,7 +19693,17 @@ "descriptionHTML": "" }, { - "name": "hook_id", + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

team_slug parameter

" + }, + { + "name": "discussion_number", "in": "path", "required": true, "schema": { @@ -12283,56 +19715,51 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/hooks/42/pings", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/hooks/42/pings
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /orgs/{org}/hooks/{hook_id}/pings', {\n org: 'org',\n hook_id: 42\n})", - "html": "
await octokit.request('POST /orgs/{org}/hooks/{hook_id}/pings', {\n  org: 'org',\n  hook_id: 42\n})\n
" + "source": "await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42\n})", + "html": "
await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42\n})\n
" } ], - "summary": "Ping an organization webhook", - "description": "This will trigger a [ping event](https://docs.github.com/github-ae@latest/webhooks/#ping-event) to be sent to the hook.", + "summary": "Delete a discussion", + "description": "Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.", "tags": [ - "orgs" + "teams" ], - "operationId": "orgs/ping-webhook", + "operationId": "teams/delete-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#ping-an-organization-webhook" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#delete-a-discussion" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "category": "orgs", - "subcategory": "webhooks" + "category": "teams", + "subcategory": "discussions" }, - "slug": "ping-an-organization-webhook", - "category": "orgs", - "categoryLabel": "Orgs", - "subcategory": "webhooks", - "subcategoryLabel": "Webhooks", + "slug": "delete-a-discussion", + "category": "teams", + "categoryLabel": "Teams", + "subcategory": "discussions", + "subcategoryLabel": "Discussions", "notes": [], "responses": [ { "httpStatusCode": "204", "httpStatusMessage": "No Content", "description": "Default Response" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" } ], "bodyParameters": [], - "descriptionHTML": "

This will trigger a ping event to be sent to the hook.

" + "descriptionHTML": "

Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.

\n

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.

" }, { "verb": "get", - "requestPath": "/orgs/{org}/installation", + "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", "serverUrl": "https://api.github.com", "parameters": [ { @@ -12343,66 +19770,41 @@ "type": "string" }, "descriptionHTML": "" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/installation", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/installation
" }, { - "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/installation', {\n org: 'org'\n})", - "html": "
await octokit.request('GET /orgs/{org}/installation', {\n  org: 'org'\n})\n
" - } - ], - "summary": "Get an organization installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", - "tags": [ - "apps" - ], - "operationId": "apps/get-org-installation", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/apps/#get-an-organization-installation-for-the-authenticated-app" - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "previews": [], - "category": "apps", - "subcategory": null - }, - "slug": "get-an-organization-installation-for-the-authenticated-app", - "category": "apps", - "categoryLabel": "Apps", - "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Enables an authenticated GitHub App to find the organization's installation information.

\n

You must use a JWT to access this endpoint.

", - "responses": [ - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Default response", - "payload": "
{\n  \"id\": 1,\n  \"account\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"avatar_url\": \"https://github.com/images/error/hubot_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"html_url\": \"https://github.com/github\",\n    \"followers_url\": \"https://api.github.com/users/github/followers\",\n    \"following_url\": \"https://api.github.com/users/github/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/github/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/github/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/github/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/github/orgs\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"received_events_url\": \"https://api.github.com/users/github/received_events\",\n    \"type\": \"Organization\",\n    \"site_admin\": false\n  },\n  \"repository_selection\": \"all\",\n  \"access_tokens_url\": \"https://api.github.com/installations/1/access_tokens\",\n  \"repositories_url\": \"https://api.github.com/installation/repositories\",\n  \"html_url\": \"https://github.com/organizations/github/settings/installations/1\",\n  \"app_id\": 1,\n  \"target_id\": 1,\n  \"target_type\": \"Organization\",\n  \"permissions\": {\n    \"checks\": \"write\",\n    \"metadata\": \"read\",\n    \"contents\": \"read\"\n  },\n  \"events\": [\n    \"push\",\n    \"pull_request\"\n  ],\n  \"created_at\": \"2018-02-09T20:51:14Z\",\n  \"updated_at\": \"2018-02-09T20:51:14Z\",\n  \"single_file_name\": \"config.yml\",\n  \"has_multiple_single_files\": true,\n  \"single_file_paths\": [\n    \"config.yml\",\n    \".github/issue_TEMPLATE.md\"\n  ],\n  \"app_slug\": \"github-actions\"\n}\n
" - } - ] - }, - { - "verb": "get", - "requestPath": "/orgs/{org}/installations", - "serverUrl": "https://api.github.com", - "parameters": [ - { - "name": "org", + "name": "team_slug", + "description": "team_slug parameter", "in": "path", "required": true, "schema": { "type": "string" }, + "descriptionHTML": "

team_slug parameter

" + }, + { + "name": "discussion_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, "descriptionHTML": "" }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + }, + "descriptionHTML": "

One of asc (ascending) or desc (descending).

" + }, { "name": "per_page", "description": "Results per page (max 100).", @@ -12427,50 +19829,59 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/installations", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/installations
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/installations', {\n org: 'org'\n})", - "html": "
await octokit.request('GET /orgs/{org}/installations', {\n  org: 'org'\n})\n
" + "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42\n})", + "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42\n})\n
" } ], - "summary": "List app installations for an organization", - "description": "Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint.", + "summary": "List discussion comments", + "description": "List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", "tags": [ - "orgs" + "teams" ], - "operationId": "orgs/list-app-installations", + "operationId": "teams/list-discussion-comments-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs/#list-app-installations-for-an-organization" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#list-discussion-comments" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": null + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", + "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + } + ], + "category": "teams", + "subcategory": "discussion-comments" }, - "slug": "list-app-installations-for-an-organization", - "category": "orgs", - "categoryLabel": "Orgs", + "slug": "list-discussion-comments", + "category": "teams", + "categoryLabel": "Teams", + "subcategory": "discussion-comments", + "subcategoryLabel": "Discussion comments", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with admin:read scope to use this endpoint.

", + "descriptionHTML": "

List all comments on a team discussion. OAuth access tokens require the read:discussion scope.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"total_count\": 1,\n  \"installations\": [\n    {\n      \"id\": 25381,\n      \"account\": {\n        \"login\": \"octo-org\",\n        \"id\": 6811672,\n        \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=\",\n        \"avatar_url\": \"https://avatars3.githubusercontent.com/u/6811672?v=4\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octo-org\",\n        \"html_url\": \"https://github.com/octo-org\",\n        \"followers_url\": \"https://api.github.com/users/octo-org/followers\",\n        \"following_url\": \"https://api.github.com/users/octo-org/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octo-org/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octo-org/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octo-org/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octo-org/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octo-org/repos\",\n        \"events_url\": \"https://api.github.com/users/octo-org/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octo-org/received_events\",\n        \"type\": \"Organization\",\n        \"site_admin\": false\n      },\n      \"repository_selection\": \"selected\",\n      \"access_tokens_url\": \"https://api.github.com/app/installations/25381/access_tokens\",\n      \"repositories_url\": \"https://api.github.com/installation/repositories\",\n      \"html_url\": \"https://github.com/organizations/octo-org/settings/installations/25381\",\n      \"app_id\": 2218,\n      \"target_id\": 6811672,\n      \"target_type\": \"Organization\",\n      \"permissions\": {\n        \"deployments\": \"write\",\n        \"metadata\": \"read\",\n        \"pull_requests\": \"read\",\n        \"statuses\": \"read\"\n      },\n      \"events\": [\n        \"deployment\",\n        \"deployment_status\"\n      ],\n      \"created_at\": \"2017-05-16T08:47:09.000-07:00\",\n      \"updated_at\": \"2017-06-06T11:23:23.000-07:00\",\n      \"single_file_name\": \"config.yml\",\n      \"has_multiple_single_files\": true,\n      \"single_file_paths\": [\n        \"config.yml\",\n        \".github/issue_TEMPLATE.md\"\n      ],\n      \"app_slug\": \"github-actions\"\n    }\n  ]\n}\n
" + "payload": "
[\n  {\n    \"author\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"body\": \"Do you like apples?\",\n    \"body_html\": \"<p>Do you like apples?</p>\",\n    \"body_version\": \"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\n    \"created_at\": \"2018-01-15T23:53:58Z\",\n    \"last_edited_at\": null,\n    \"discussion_url\": \"https://api.github.com/teams/2403582/discussions/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\n    \"node_id\": \"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\n    \"number\": 1,\n    \"updated_at\": \"2018-01-15T23:53:58Z\",\n    \"url\": \"https://api.github.com/teams/2403582/discussions/1/comments/1\",\n    \"reactions\": {\n      \"url\": \"https://api.github.com/teams/2403582/discussions/1/reactions\",\n      \"total_count\": 5,\n      \"+1\": 3,\n      \"-1\": 1,\n      \"laugh\": 0,\n      \"confused\": 0,\n      \"heart\": 1,\n      \"hooray\": 0,\n      \"eyes\": 1,\n      \"rocket\": 1\n    }\n  }\n]\n
" } ] }, { - "verb": "get", - "requestPath": "/orgs/{org}/issues", + "verb": "post", + "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", "serverUrl": "https://api.github.com", "parameters": [ { @@ -12483,136 +19894,77 @@ "descriptionHTML": "" }, { - "name": "filter", - "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "assigned", - "created", - "mentioned", - "subscribed", - "all" - ], - "default": "assigned" - }, - "descriptionHTML": "

Indicates which sorts of issues to return. Can be one of:
\n* assigned: Issues assigned to you
\n* created: Issues created by you
\n* mentioned: Issues mentioning you
\n* subscribed: Issues you're subscribed to updates for
\n* all: All issues the authenticated user can see, regardless of participation or creation

" - }, - { - "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - }, - "descriptionHTML": "

Indicates the state of the issues to return. Can be either open, closed, or all.

" - }, - { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "in": "query", - "required": false, - "schema": { - "type": "string" - }, - "descriptionHTML": "

A list of comma separated label names. Example: bug,ui,@high

" - }, - { - "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "comments" - ], - "default": "created" - }, - "descriptionHTML": "

What to sort results by. Can be either created, updated, comments.

" - }, - { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - }, - "descriptionHTML": "

One of asc (ascending) or desc (descending).

" - }, - { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

Only show notifications updated after the given time. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

" - }, - { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - }, - "descriptionHTML": "

Results per page (max 100).

" + "descriptionHTML": "

team_slug parameter

" }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", + "name": "discussion_number", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" }, - "descriptionHTML": "

Page number of the results to fetch.

" + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/issues", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/issues
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/issues', {\n org: 'org'\n})", - "html": "
await octokit.request('GET /orgs/{org}/issues', {\n  org: 'org'\n})\n
" + "source": "await octokit.request('POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n body: 'body'\n})", + "html": "
await octokit.request('POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  body: 'body'\n})\n
" } ], - "summary": "List organization issues assigned to the authenticated user", - "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests)\" endpoint.", + "summary": "Create a discussion comment", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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 abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", "tags": [ - "issues" + "teams" ], - "operationId": "issues/list-for-org", + "operationId": "teams/create-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/issues/#list-organization-issues-assigned-to-the-authenticated-user" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-discussion-comment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "

Required. The discussion comment's body text.

", + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The discussion comment's body text.", + "childParamsGroups": [] + } + }, + "required": [ + "body" + ] + }, + "example": { + "body": "Do you like apples?" + } + } + } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "previews": [ { "required": false, @@ -12621,32 +19973,39 @@ "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" } ], - "category": "issues", - "subcategory": null + "category": "teams", + "subcategory": "discussion-comments" }, - "slug": "list-organization-issues-assigned-to-the-authenticated-user", - "category": "issues", - "categoryLabel": "Issues", + "slug": "create-a-discussion-comment", + "category": "teams", + "categoryLabel": "Teams", + "subcategory": "discussion-comments", + "subcategoryLabel": "Discussion comments", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

List issues in an organization assigned to the authenticated user.

\n

Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe pull_request key. Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull\nrequest id, use the \"List pull requests\" endpoint.

", + "descriptionHTML": "

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.

", + "bodyParameters": [ + { + "type": "string", + "description": "

Required. The discussion comment's body text.

", + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The discussion comment's body text.", + "childParamsGroups": [] + } + ], "responses": [ { - "httpStatusCode": "200", - "httpStatusMessage": "OK", + "httpStatusCode": "201", + "httpStatusMessage": "Created", "description": "Default response", - "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDU6SXNzdWUx\",\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347\",\n    \"repository_url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/comments\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/1347/events\",\n    \"html_url\": \"https://github.com/octocat/Hello-World/issues/1347\",\n    \"number\": 1347,\n    \"state\": \"open\",\n    \"title\": \"Found a bug\",\n    \"body\": \"I'm having a problem with this.\",\n    \"user\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"labels\": [\n      {\n        \"id\": 208045946,\n        \"node_id\": \"MDU6TGFiZWwyMDgwNDU5NDY=\",\n        \"url\": \"https://api.github.com/repos/octocat/Hello-World/labels/bug\",\n        \"name\": \"bug\",\n        \"description\": \"Something isn't working\",\n        \"color\": \"f29513\",\n        \"default\": true\n      }\n    ],\n    \"assignee\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"assignees\": [\n      {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      }\n    ],\n    \"milestone\": {\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1\",\n      \"html_url\": \"https://github.com/octocat/Hello-World/milestones/v1.0\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones/1/labels\",\n      \"id\": 1002604,\n      \"node_id\": \"MDk6TWlsZXN0b25lMTAwMjYwNA==\",\n      \"number\": 1,\n      \"state\": \"open\",\n      \"title\": \"v1.0\",\n      \"description\": \"Tracking milestone for version 1.0\",\n      \"creator\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"open_issues\": 4,\n      \"closed_issues\": 8,\n      \"created_at\": \"2011-04-10T20:09:31Z\",\n      \"updated_at\": \"2014-03-03T18:58:10Z\",\n      \"closed_at\": \"2013-02-12T13:22:01Z\",\n      \"due_on\": \"2012-10-09T23:39:01Z\"\n    },\n    \"locked\": true,\n    \"active_lock_reason\": \"too heated\",\n    \"comments\": 0,\n    \"pull_request\": {\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World/pulls/1347\",\n      \"html_url\": \"https://github.com/octocat/Hello-World/pull/1347\",\n      \"diff_url\": \"https://github.com/octocat/Hello-World/pull/1347.diff\",\n      \"patch_url\": \"https://github.com/octocat/Hello-World/pull/1347.patch\"\n    },\n    \"closed_at\": null,\n    \"created_at\": \"2011-04-22T13:33:48Z\",\n    \"updated_at\": \"2011-04-22T13:33:48Z\",\n    \"repository\": {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World\",\n      \"full_name\": \"octocat/Hello-World\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"template_repository\": null,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://github.com/licenses/mit\"\n      },\n      \"forks\": 1,\n      \"open_issues\": 1,\n      \"watchers\": 1\n    },\n    \"author_association\": \"COLLABORATOR\"\n  }\n]\n
" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "payload": "
{\n  \"author\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"body\": \"Do you like apples?\",\n  \"body_html\": \"<p>Do you like apples?</p>\",\n  \"body_version\": \"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\n  \"created_at\": \"2018-01-15T23:53:58Z\",\n  \"last_edited_at\": null,\n  \"discussion_url\": \"https://api.github.com/teams/2403582/discussions/1\",\n  \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\n  \"node_id\": \"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\n  \"number\": 1,\n  \"updated_at\": \"2018-01-15T23:53:58Z\",\n  \"url\": \"https://api.github.com/teams/2403582/discussions/1/comments/1\",\n  \"reactions\": {\n    \"url\": \"https://api.github.com/teams/2403582/discussions/1/reactions\",\n    \"total_count\": 5,\n    \"+1\": 3,\n    \"-1\": 1,\n    \"laugh\": 0,\n    \"confused\": 0,\n    \"heart\": 1,\n    \"hooray\": 0,\n    \"eyes\": 1,\n    \"rocket\": 1\n  }\n}\n
" } ] }, { "verb": "get", - "requestPath": "/orgs/{org}/members", + "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", "serverUrl": "https://api.github.com", "parameters": [ { @@ -12659,116 +20018,90 @@ "descriptionHTML": "" }, { - "name": "filter", - "description": "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. \n\\* `all` - All members the authenticated user can see.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "2fa_disabled", - "all" - ], - "default": "all" - }, - "descriptionHTML": "

Filter members returned in the list. Can be one of:
\n* 2fa_disabled - Members without two-factor authentication enabled. Available for organization owners.
\n* all - All members the authenticated user can see.

" - }, - { - "name": "role", - "description": "Filter members returned by their role. Can be one of: \n\\* `all` - All members of the organization, regardless of role. \n\\* `admin` - Organization owners. \n\\* `member` - Non-owner organization members.", - "in": "query", - "required": false, + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "all", - "admin", - "member" - ], - "default": "all" + "type": "string" }, - "descriptionHTML": "

Filter members returned by their role. Can be one of:
\n* all - All members of the organization, regardless of role.
\n* admin - Organization owners.
\n* member - Non-owner organization members.

" + "descriptionHTML": "

team_slug parameter

" }, { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", + "name": "discussion_number", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "integer" }, - "descriptionHTML": "

Results per page (max 100).

" + "descriptionHTML": "" }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", + "name": "comment_number", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" }, - "descriptionHTML": "

Page number of the results to fetch.

" + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/members', {\n org: 'org'\n})", - "html": "
await octokit.request('GET /orgs/{org}/members', {\n  org: 'org'\n})\n
" + "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n comment_number: 42\n})", + "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  comment_number: 42\n})\n
" } ], - "summary": "List organization members", - "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.", + "summary": "Get a discussion comment", + "description": "Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.", "tags": [ - "orgs" + "teams" ], - "operationId": "orgs/list-members", + "operationId": "teams/get-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#list-organization-members" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#get-a-discussion-comment" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "members" + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", + "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + } + ], + "category": "teams", + "subcategory": "discussion-comments" }, - "slug": "list-organization-members", - "category": "orgs", - "categoryLabel": "Orgs", - "subcategory": "members", - "subcategoryLabel": "Members", + "slug": "get-a-discussion-comment", + "category": "teams", + "categoryLabel": "Teams", + "subcategory": "discussion-comments", + "subcategoryLabel": "Discussion comments", "notes": [], "bodyParameters": [], - "descriptionHTML": "

List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.

", + "descriptionHTML": "

Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n]\n
" - }, - { - "httpStatusCode": "302", - "httpStatusMessage": "Found", - "description": "Response if requester is not an organization member" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "payload": "
{\n  \"author\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"body\": \"Do you like apples?\",\n  \"body_html\": \"<p>Do you like apples?</p>\",\n  \"body_version\": \"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\n  \"created_at\": \"2018-01-15T23:53:58Z\",\n  \"last_edited_at\": null,\n  \"discussion_url\": \"https://api.github.com/teams/2403582/discussions/1\",\n  \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\n  \"node_id\": \"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\n  \"number\": 1,\n  \"updated_at\": \"2018-01-15T23:53:58Z\",\n  \"url\": \"https://api.github.com/teams/2403582/discussions/1/comments/1\",\n  \"reactions\": {\n    \"url\": \"https://api.github.com/teams/2403582/discussions/1/reactions\",\n    \"total_count\": 5,\n    \"+1\": 3,\n    \"-1\": 1,\n    \"laugh\": 0,\n    \"confused\": 0,\n    \"heart\": 1,\n    \"hooray\": 0,\n    \"eyes\": 1,\n    \"rocket\": 1\n  }\n}\n
" } ] }, { - "verb": "get", - "requestPath": "/orgs/{org}/members/{username}", + "verb": "patch", + "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", "serverUrl": "https://api.github.com", "parameters": [ { @@ -12781,73 +20114,126 @@ "descriptionHTML": "" }, { - "name": "username", + "name": "team_slug", + "description": "team_slug parameter", "in": "path", "required": true, "schema": { "type": "string" }, + "descriptionHTML": "

team_slug parameter

" + }, + { + "name": "discussion_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + }, + { + "name": "comment_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members/USERNAME
" + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", + "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/members/{username}', {\n org: 'org',\n username: 'username'\n})", - "html": "
await octokit.request('GET /orgs/{org}/members/{username}', {\n  org: 'org',\n  username: 'username'\n})\n
" + "source": "await octokit.request('PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n comment_number: 42,\n body: 'body'\n})", + "html": "
await octokit.request('PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  comment_number: 42,\n  body: 'body'\n})\n
" } ], - "summary": "Check organization membership for a user", - "description": "Check if a user is, publicly or privately, a member of the organization.", + "summary": "Update a discussion comment", + "description": "Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.", "tags": [ - "orgs" + "teams" ], - "operationId": "orgs/check-membership-for-user", + "operationId": "teams/update-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#check-organization-membership-for-a-user" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#update-a-discussion-comment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "

Required. The discussion comment's body text.

", + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The discussion comment's body text.", + "childParamsGroups": [] + } + }, + "required": [ + "body" + ] + }, + "example": { + "body": "Do you like pineapples?" + } + } + } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "members" + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", + "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + } + ], + "category": "teams", + "subcategory": "discussion-comments" }, - "slug": "check-organization-membership-for-a-user", - "category": "orgs", - "categoryLabel": "Orgs", - "subcategory": "members", - "subcategoryLabel": "Members", + "slug": "update-a-discussion-comment", + "category": "teams", + "categoryLabel": "Teams", + "subcategory": "discussion-comments", + "subcategoryLabel": "Discussion comments", "notes": [], - "responses": [ - { - "httpStatusCode": "204", - "httpStatusMessage": "No Content", - "description": "Response if requester is an organization member and user is a member" - }, - { - "httpStatusCode": "302", - "httpStatusMessage": "Found", - "description": "Response if requester is not an organization member" - }, + "descriptionHTML": "

Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.

\n

Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.

", + "bodyParameters": [ { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Response if requester is an organization member and user is not a member" + "type": "string", + "description": "

Required. The discussion comment's body text.

", + "name": "body", + "in": "body", + "rawType": "string", + "rawDescription": "The discussion comment's body text.", + "childParamsGroups": [] } ], - "bodyParameters": [], - "descriptionHTML": "

Check if a user is, publicly or privately, a member of the organization.

" + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"author\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"body\": \"Do you like pineapples?\",\n  \"body_html\": \"<p>Do you like pineapples?</p>\",\n  \"body_version\": \"e6907b24d9c93cc0c5024a7af5888116\",\n  \"created_at\": \"2018-01-15T23:53:58Z\",\n  \"last_edited_at\": \"2018-01-26T18:22:20Z\",\n  \"discussion_url\": \"https://api.github.com/teams/2403582/discussions/1\",\n  \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\n  \"node_id\": \"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\n  \"number\": 1,\n  \"updated_at\": \"2018-01-26T18:22:20Z\",\n  \"url\": \"https://api.github.com/teams/2403582/discussions/1/comments/1\",\n  \"reactions\": {\n    \"url\": \"https://api.github.com/teams/2403582/discussions/1/reactions\",\n    \"total_count\": 5,\n    \"+1\": 3,\n    \"-1\": 1,\n    \"laugh\": 0,\n    \"confused\": 0,\n    \"heart\": 1,\n    \"hooray\": 0,\n    \"eyes\": 1,\n    \"rocket\": 1\n  }\n}\n
" + } + ] }, { "verb": "delete", - "requestPath": "/orgs/{org}/members/{username}", + "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", "serverUrl": "https://api.github.com", "parameters": [ { @@ -12860,68 +20246,82 @@ "descriptionHTML": "" }, { - "name": "username", + "name": "team_slug", + "description": "team_slug parameter", "in": "path", "required": true, "schema": { "type": "string" }, + "descriptionHTML": "

team_slug parameter

" + }, + { + "name": "discussion_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + }, + { + "name": "comment_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/members/USERNAME", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/members/USERNAME
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /orgs/{org}/members/{username}', {\n org: 'org',\n username: 'username'\n})", - "html": "
await octokit.request('DELETE /orgs/{org}/members/{username}', {\n  org: 'org',\n  username: 'username'\n})\n
" + "source": "await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n comment_number: 42\n})", + "html": "
await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  comment_number: 42\n})\n
" } ], - "summary": "Remove an organization member", - "description": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.", + "summary": "Delete a discussion comment", + "description": "Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.", "tags": [ - "orgs" + "teams" ], - "operationId": "orgs/remove-member", + "operationId": "teams/delete-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#remove-an-organization-member" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#delete-a-discussion-comment" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "category": "orgs", - "subcategory": "members" + "category": "teams", + "subcategory": "discussion-comments" }, - "slug": "remove-an-organization-member", - "category": "orgs", - "categoryLabel": "Orgs", - "subcategory": "members", - "subcategoryLabel": "Members", + "slug": "delete-a-discussion-comment", + "category": "teams", + "categoryLabel": "Teams", + "subcategory": "discussion-comments", + "subcategoryLabel": "Discussion comments", "notes": [], "responses": [ { "httpStatusCode": "204", "httpStatusMessage": "No Content", "description": "Default Response" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" } ], "bodyParameters": [], - "descriptionHTML": "

Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.

" + "descriptionHTML": "

Deletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.

" }, { "verb": "get", - "requestPath": "/orgs/{org}/memberships/{username}", + "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", "serverUrl": "https://api.github.com", "parameters": [ { @@ -12934,103 +20334,164 @@ "descriptionHTML": "" }, { - "name": "username", + "name": "team_slug", + "description": "team_slug parameter", "in": "path", "required": true, "schema": { "type": "string" }, + "descriptionHTML": "

team_slug parameter

" + }, + { + "name": "discussion_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + }, + { + "name": "comment_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, "descriptionHTML": "" + }, + { + "name": "content", + "description": "Returns a single [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + }, + "descriptionHTML": "

Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.

" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME
" + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/memberships/{username}', {\n org: 'org',\n username: 'username'\n})", - "html": "
await octokit.request('GET /orgs/{org}/memberships/{username}', {\n  org: 'org',\n  username: 'username'\n})\n
" + "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n comment_number: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})", + "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  comment_number: 42,\n  mediaType: {\n    previews: [\n      'squirrel-girl'\n    ]\n  }\n})\n
" } ], - "summary": "Get organization membership for a user", - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "summary": "List reactions for a team discussion comment", + "description": "List the reactions to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.", "tags": [ - "orgs" + "reactions" ], - "operationId": "orgs/get-membership-for-user", + "operationId": "reactions/list-for-team-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#get-organization-membership-for-a-user" + "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#list-reactions-for-a-team-discussion-comment" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "members" + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", + "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + } + ], + "category": "reactions", + "subcategory": null }, - "slug": "get-organization-membership-for-a-user", - "category": "orgs", - "categoryLabel": "Orgs", - "subcategory": "members", - "subcategoryLabel": "Members", + "slug": "list-reactions-for-a-team-discussion-comment", + "category": "reactions", + "categoryLabel": "Reactions", "notes": [], "bodyParameters": [], - "descriptionHTML": "

In order to get a user's membership with an organization, the authenticated user must be an organization member.

", + "descriptionHTML": "

List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "Response if user has an active admin membership with organization", - "payload": "
{\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n}\n
" - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with organization", - "payload": "
{\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"member\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n}\n
" - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with organization", - "payload": "
{\n  \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n  \"state\": \"pending\",\n  \"role\": \"member\",\n  \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n}\n
" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "description": "Default response", + "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDg6UmVhY3Rpb24x\",\n    \"user\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"content\": \"heart\",\n    \"created_at\": \"2016-05-20T20:09:31Z\"\n  }\n]\n
" } ] }, { - "verb": "put", - "requestPath": "/orgs/{org}/memberships/{username}", + "verb": "post", + "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "team_slug", + "description": "team_slug parameter", "in": "path", "required": true, "schema": { "type": "string" }, + "descriptionHTML": "

team_slug parameter

" + }, + { + "name": "discussion_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, "descriptionHTML": "" }, { - "name": "username", + "name": "comment_number", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" }, "descriptionHTML": "" } @@ -13038,24 +20499,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /orgs/{org}/memberships/{username}', {\n org: 'org',\n username: 'username',\n role: 'role'\n})", - "html": "
await octokit.request('PUT /orgs/{org}/memberships/{username}', {\n  org: 'org',\n  username: 'username',\n  role: 'role'\n})\n
" + "source": "await octokit.request('POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n comment_number: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})", + "html": "
await octokit.request('POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  comment_number: 42,\n  content: 'content',\n  mediaType: {\n    previews: [\n      'squirrel-girl'\n    ]\n  }\n})\n
" } ], - "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/github-ae@latest/rest/reference/orgs#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "summary": "Create reaction for a team discussion comment", + "description": "Create a reaction to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.", "tags": [ - "orgs" + "reactions" ], - "operationId": "orgs/set-membership-for-user", + "operationId": "reactions/create-for-team-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#set-organization-membership-for-a-user" + "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#create-reaction-for-a-team-discussion-comment" }, "requestBody": { "content": { @@ -13063,21 +20524,32 @@ "schema": { "type": "object", "properties": { - "role": { + "content": { "type": "string", - "description": "

The role to give the user in the organization. Can be one of:
\n* admin - The user will become an owner of the organization.
\n* member - The user will become a non-owner member of the organization.

", + "description": "

Required. The reaction type to add to the team discussion comment.

", "enum": [ - "admin", - "member" + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" ], - "default": "member", - "name": "role", + "name": "content", "in": "body", "rawType": "string", - "rawDescription": "The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.", + "rawDescription": "The [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types) to add to the team discussion comment.", "childParamsGroups": [] } - } + }, + "required": [ + "content" + ] + }, + "example": { + "content": "heart" } } } @@ -13085,61 +20557,55 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "members" + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", + "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + } + ], + "category": "reactions", + "subcategory": null }, - "slug": "set-organization-membership-for-a-user", - "category": "orgs", - "categoryLabel": "Orgs", - "subcategory": "members", - "subcategoryLabel": "Members", + "slug": "create-reaction-for-a-team-discussion-comment", + "category": "reactions", + "categoryLabel": "Reactions", "notes": [], - "descriptionHTML": "

Only authenticated organization owners can add a member to the organization or update the member's role.

\n
    \n
  • If the authenticated user is adding a member to the organization, the invited user will receive an email inviting them to the organization. The user's membership status will be pending until they accept the invitation.
    • \n
  • Authenticated users can update a user's membership by passing the role parameter. If the authenticated user changes a member's role to admin, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to member, no email will be sent.
    • \n
\n

Rate limits

\n

To prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.

", + "descriptionHTML": "

Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion comment.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.

", "bodyParameters": [ { "type": "string", - "description": "

The role to give the user in the organization. Can be one of:
\n* admin - The user will become an owner of the organization.
\n* member - The user will become a non-owner member of the organization.

", + "description": "

Required. The reaction type to add to the team discussion comment.

", "enum": [ - "admin", - "member" + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" ], - "default": "member", - "name": "role", + "name": "content", "in": "body", "rawType": "string", - "rawDescription": "The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.", + "rawDescription": "The [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types) to add to the team discussion comment.", "childParamsGroups": [] } ], "responses": [ { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user was previously unaffiliated with organization", - "payload": "
{\n  \"url\": \"https://api.github.com/orgs/invitocat/memberships/defunkt\",\n  \"state\": \"pending\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/invitocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n}\n
" - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user already had membership with organization", - "payload": "
{\n  \"url\": \"https://api.github.com/orgs/octocat/memberships/defunkt\",\n  \"state\": \"active\",\n  \"role\": \"admin\",\n  \"organization_url\": \"https://api.github.com/orgs/octocat\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\"\n  },\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n}\n
" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Default response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDg6UmVhY3Rpb24x\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"content\": \"heart\",\n  \"created_at\": \"2016-05-20T20:09:31Z\"\n}\n
" } ] }, { "verb": "delete", - "requestPath": "/orgs/{org}/memberships/{username}", + "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", "serverUrl": "https://api.github.com", "parameters": [ { @@ -13152,73 +20618,96 @@ "descriptionHTML": "" }, { - "name": "username", + "name": "team_slug", + "description": "team_slug parameter", "in": "path", "required": true, "schema": { "type": "string" }, + "descriptionHTML": "

team_slug parameter

" + }, + { + "name": "discussion_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + }, + { + "name": "comment_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + }, + { + "name": "reaction_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/memberships/USERNAME", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/memberships/USERNAME
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /orgs/{org}/memberships/{username}', {\n org: 'org',\n username: 'username'\n})", - "html": "
await octokit.request('DELETE /orgs/{org}/memberships/{username}', {\n  org: 'org',\n  username: 'username'\n})\n
" + "source": "await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n comment_number: 42,\n reaction_id: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})", + "html": "
await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  comment_number: 42,\n  reaction_id: 42,\n  mediaType: {\n    previews: [\n      'squirrel-girl'\n    ]\n  }\n})\n
" } ], - "summary": "Remove organization membership for a user", - "description": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.", + "summary": "Delete team discussion comment reaction", + "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "tags": [ - "orgs" + "reactions" ], - "operationId": "orgs/remove-membership-for-user", + "operationId": "reactions/delete-for-team-discussion-comment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#remove-organization-membership-for-a-user" + "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#delete-team-discussion-comment-reaction" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "members" + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", + "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + } + ], + "category": "reactions", + "subcategory": null }, - "slug": "remove-organization-membership-for-a-user", - "category": "orgs", - "categoryLabel": "Orgs", - "subcategory": "members", - "subcategoryLabel": "Members", + "slug": "delete-team-discussion-comment-reaction", + "category": "reactions", + "categoryLabel": "Reactions", "notes": [], "responses": [ { "httpStatusCode": "204", "httpStatusMessage": "No Content", "description": "Default Response" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" } ], "bodyParameters": [], - "descriptionHTML": "

In order to remove a user's membership with an organization, the authenticated user must be an organization owner.

\n

If the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.

" + "descriptionHTML": "

Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.

\n

Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.

" }, { "verb": "get", - "requestPath": "/orgs/{org}/outside_collaborators", + "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", "serverUrl": "https://api.github.com", "parameters": [ { @@ -13231,19 +20720,43 @@ "descriptionHTML": "" }, { - "name": "filter", - "description": "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. \n\\* `all`: All outside collaborators.", + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

team_slug parameter

" + }, + { + "name": "discussion_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + }, + { + "name": "content", + "description": "Returns a single [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "2fa_disabled", - "all" - ], - "default": "all" + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] }, - "descriptionHTML": "

Filter the list of outside collaborators. Can be one of:
\n* 2fa_disabled: Outside collaborators without two-factor authentication enabled.
\n* all: All outside collaborators.

" + "descriptionHTML": "

Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.

" }, { "name": "per_page", @@ -13269,52 +20782,57 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators
" + "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/outside_collaborators', {\n org: 'org'\n})", - "html": "
await octokit.request('GET /orgs/{org}/outside_collaborators', {\n  org: 'org'\n})\n
" + "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})", + "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  mediaType: {\n    previews: [\n      'squirrel-girl'\n    ]\n  }\n})\n
" } ], - "summary": "List outside collaborators for an organization", - "description": "List all users who are outside collaborators of an organization.", + "summary": "List reactions for a team discussion", + "description": "List the reactions to a [team discussion](https://docs.github.com/github-ae@latest/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.", "tags": [ - "orgs" + "reactions" ], - "operationId": "orgs/list-outside-collaborators", + "operationId": "reactions/list-for-team-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#list-outside-collaborators-for-an-organization" + "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#list-reactions-for-a-team-discussion" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "outside-collaborators" + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", + "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + } + ], + "category": "reactions", + "subcategory": null }, - "slug": "list-outside-collaborators-for-an-organization", - "category": "orgs", - "categoryLabel": "Orgs", - "subcategory": "outside-collaborators", - "subcategoryLabel": "Outside collaborators", + "slug": "list-reactions-for-a-team-discussion", + "category": "reactions", + "categoryLabel": "Reactions", "notes": [], "bodyParameters": [], - "descriptionHTML": "

List all users who are outside collaborators of an organization.

", + "descriptionHTML": "

List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n]\n
" + "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDg6UmVhY3Rpb24x\",\n    \"user\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"content\": \"heart\",\n    \"created_at\": \"2016-05-20T20:09:31Z\"\n  }\n]\n
" } ] }, { - "verb": "put", - "requestPath": "/orgs/{org}/outside_collaborators/{username}", + "verb": "post", + "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", "serverUrl": "https://api.github.com", "parameters": [ { @@ -13327,85 +20845,135 @@ "descriptionHTML": "" }, { - "name": "username", + "name": "team_slug", + "description": "team_slug parameter", "in": "path", "required": true, "schema": { "type": "string" }, + "descriptionHTML": "

team_slug parameter

" + }, + { + "name": "discussion_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators/USERNAME
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /orgs/{org}/outside_collaborators/{username}', {\n org: 'org',\n username: 'username'\n})", - "html": "
await octokit.request('PUT /orgs/{org}/outside_collaborators/{username}', {\n  org: 'org',\n  username: 'username'\n})\n
" + "source": "await octokit.request('POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})", + "html": "
await octokit.request('POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  content: 'content',\n  mediaType: {\n    previews: [\n      'squirrel-girl'\n    ]\n  }\n})\n
" } ], - "summary": "Convert an organization member to outside collaborator", - "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\".", + "summary": "Create reaction for a team discussion", + "description": "Create a reaction to a [team discussion](https://docs.github.com/github-ae@latest/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.", "tags": [ - "orgs" + "reactions" ], - "operationId": "orgs/convert-member-to-outside-collaborator", + "operationId": "reactions/create-for-team-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator" + "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#create-reaction-for-a-team-discussion" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "

Required. The reaction type to add to the team discussion.

", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "in": "body", + "rawType": "string", + "rawDescription": "The [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types) to add to the team discussion.", + "childParamsGroups": [] + } + }, + "required": [ + "content" + ] + }, + "example": { + "content": "heart" + } + } + } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "outside-collaborators" + "enabledForGitHubApps": false, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", + "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + } + ], + "category": "reactions", + "subcategory": null }, - "slug": "convert-an-organization-member-to-outside-collaborator", - "category": "orgs", - "categoryLabel": "Orgs", - "subcategory": "outside-collaborators", - "subcategoryLabel": "Outside collaborators", + "slug": "create-reaction-for-a-team-discussion", + "category": "reactions", + "categoryLabel": "Reactions", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"Converting an organization member to an outside collaborator\".

", - "responses": [ - { - "httpStatusCode": "202", - "httpStatusMessage": "Accepted", - "description": "User is getting converted asynchronously" - }, - { - "httpStatusCode": "204", - "httpStatusMessage": "No Content", - "description": "User was converted" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Response if user is the last owner of the organization", - "payload": "
{\n  \"message\": \"Cannot convert the last owner to an outside collaborator\",\n  \"documentation_url\": \"https://docs.github.com/github-ae@latest/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
" - }, + "descriptionHTML": "

Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.

", + "bodyParameters": [ { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Response if user is not a member of the organization", - "payload": "
{\n  \"message\": \"<user> is not a member of the <organization> organization.\",\n  \"documentation_url\": \"https://docs.github.com/github-ae@latest/rest/reference/orgs#convert-member-to-outside-collaborator\"\n}\n
" - }, + "type": "string", + "description": "

Required. The reaction type to add to the team discussion.

", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ], + "name": "content", + "in": "body", + "rawType": "string", + "rawDescription": "The [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types) to add to the team discussion.", + "childParamsGroups": [] + } + ], + "responses": [ { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Default response", + "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDg6UmVhY3Rpb24x\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"content\": \"heart\",\n  \"created_at\": \"2016-05-20T20:09:31Z\"\n}\n
" } ] }, { "verb": "delete", - "requestPath": "/orgs/{org}/outside_collaborators/{username}", + "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", "serverUrl": "https://api.github.com", "parameters": [ { @@ -13418,69 +20986,87 @@ "descriptionHTML": "" }, { - "name": "username", + "name": "team_slug", + "description": "team_slug parameter", "in": "path", "required": true, "schema": { "type": "string" }, + "descriptionHTML": "

team_slug parameter

" + }, + { + "name": "discussion_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + }, + { + "name": "reaction_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/outside_collaborators/USERNAME", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/outside_collaborators/USERNAME
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /orgs/{org}/outside_collaborators/{username}', {\n org: 'org',\n username: 'username'\n})", - "html": "
await octokit.request('DELETE /orgs/{org}/outside_collaborators/{username}', {\n  org: 'org',\n  username: 'username'\n})\n
" + "source": "await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n reaction_id: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})", + "html": "
await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  reaction_id: 42,\n  mediaType: {\n    previews: [\n      'squirrel-girl'\n    ]\n  }\n})\n
" } ], - "summary": "Remove outside collaborator from an organization", - "description": "Removing a user from this list will remove them from all the organization's repositories.", + "summary": "Delete team discussion reaction", + "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/github-ae@latest/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", "tags": [ - "orgs" + "reactions" ], - "operationId": "orgs/remove-outside-collaborator", + "operationId": "reactions/delete-for-team-discussion", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#remove-outside-collaborator-from-an-organization" + "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#delete-team-discussion-reaction" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], - "category": "orgs", - "subcategory": "outside-collaborators" + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", + "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + } + ], + "category": "reactions", + "subcategory": null }, - "slug": "remove-outside-collaborator-from-an-organization", - "category": "orgs", - "categoryLabel": "Orgs", - "subcategory": "outside-collaborators", - "subcategoryLabel": "Outside collaborators", + "slug": "delete-team-discussion-reaction", + "category": "reactions", + "categoryLabel": "Reactions", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Removing a user from this list will remove them from all the organization's repositories.

", "responses": [ { "httpStatusCode": "204", "httpStatusMessage": "No Content", "description": "Default Response" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Response if user is a member of the organization", - "payload": "
{\n  \"message\": \"You cannot specify an organization member to remove as an outside collaborator.\",\n  \"documentation_url\": \"https://docs.github.com/github-ae@latest/rest/reference/orgs#remove-outside-collaborator\"\n}\n
" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.

\n

Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.

" }, { "verb": "get", - "requestPath": "/orgs/{org}/projects", + "requestPath": "/orgs/{org}/teams/{team_slug}/members", "serverUrl": "https://api.github.com", "parameters": [ { @@ -13493,20 +21079,30 @@ "descriptionHTML": "" }, { - "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

team_slug parameter

" + }, + { + "name": "role", + "description": "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "open", - "closed", + "member", + "maintainer", "all" ], - "default": "open" + "default": "all" }, - "descriptionHTML": "

Indicates the state of the projects to return. Can be either open, closed, or all.

" + "descriptionHTML": "

Filters members returned by their role in the team. Can be one of:
\n* member - normal members of the team.
\n* maintainer - team maintainers.
\n* all - all members of the team.

" }, { "name": "per_page", @@ -13532,62 +21128,52 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/projects
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/members", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/members
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/projects', {\n org: 'org',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('GET /orgs/{org}/projects', {\n  org: 'org',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/members', {\n org: 'org',\n team_slug: 'team_slug'\n})", + "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/members', {\n  org: 'org',\n  team_slug: 'team_slug'\n})\n
" } ], - "summary": "List organization projects", - "description": "Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "summary": "List team members", + "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", "tags": [ - "projects" + "teams" ], - "operationId": "projects/list-for-org", + "operationId": "teams/list-members-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects/#list-organization-projects" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#list-team-members" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "projects", - "subcategory": null + "previews": [], + "category": "teams", + "subcategory": "members" }, - "slug": "list-organization-projects", - "category": "projects", - "categoryLabel": "Projects", + "slug": "list-team-members", + "category": "teams", + "categoryLabel": "Teams", + "subcategory": "members", + "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Lists the projects in an organization. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

", + "descriptionHTML": "

Team members will include the members of child teams.

\n

To list members in a team, the team must be visible to the authenticated user.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"owner_url\": \"https://api.github.com/orgs/octocat\",\n    \"url\": \"https://api.github.com/projects/1002605\",\n    \"html_url\": \"https://github.com/orgs/api-playground/projects/1\",\n    \"columns_url\": \"https://api.github.com/projects/1002605/columns\",\n    \"id\": 1002605,\n    \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDU=\",\n    \"name\": \"Organization Roadmap\",\n    \"body\": \"High-level roadmap for the upcoming year.\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"created_at\": \"2011-04-11T20:09:31Z\",\n    \"updated_at\": \"2014-03-04T18:58:10Z\"\n  }\n]\n
" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "payload": "
[\n  {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n]\n
" } ] }, { - "verb": "post", - "requestPath": "/orgs/{org}/projects", + "verb": "get", + "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", "serverUrl": "https://api.github.com", "parameters": [ { @@ -13598,223 +21184,93 @@ "type": "string" }, "descriptionHTML": "" - } - ], - "x-codeSamples": [ - { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/projects \\\n -d '{\"name\":\"name\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/projects \\\n  -d '{\"name\":\"name\"}'
" - }, - { - "lang": "JavaScript", - "source": "await octokit.request('POST /orgs/{org}/projects', {\n org: 'org',\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('POST /orgs/{org}/projects', {\n  org: 'org',\n  name: 'name',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" - } - ], - "summary": "Create an organization project", - "description": "Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "tags": [ - "projects" - ], - "operationId": "projects/create-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects/#create-an-organization-project" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "

Required. The name of the project.

", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the project.", - "childParamsGroups": [] - }, - "body": { - "type": "string", - "description": "

The description of the project.

", - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The description of the project.", - "childParamsGroups": [] - } - }, - "required": [ - "name" - ] - }, - "example": { - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year." - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "projects", - "subcategory": null - }, - "slug": "create-an-organization-project", - "category": "projects", - "categoryLabel": "Projects", - "notes": [], - "descriptionHTML": "

Creates an organization project board. Returns a 404 Not Found status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

", - "bodyParameters": [ - { - "type": "string", - "description": "

Required. The name of the project.

", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the project.", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

The description of the project.

", - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "The description of the project.", - "childParamsGroups": [] - } - ], - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Default response", - "payload": "
{\n  \"owner_url\": \"https://api.github.com/orgs/octocat\",\n  \"url\": \"https://api.github.com/projects/1002605\",\n  \"html_url\": \"https://github.com/orgs/api-playground/projects/1\",\n  \"columns_url\": \"https://api.github.com/projects/1002605/columns\",\n  \"id\": 1002605,\n  \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDU=\",\n  \"name\": \"Organization Roadmap\",\n  \"body\": \"High-level roadmap for the upcoming year.\",\n  \"number\": 1,\n  \"state\": \"open\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2011-04-11T20:09:31Z\",\n  \"updated_at\": \"2014-03-04T18:58:10Z\"\n}\n
" - }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" }, { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] - }, - { - "verb": "get", - "requestPath": "/orgs/{org}/public_members", - "serverUrl": "https://api.github.com", - "parameters": [ - { - "name": "org", + "name": "team_slug", + "description": "team_slug parameter", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "" - }, - { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - }, - "descriptionHTML": "

Results per page (max 100).

" + "descriptionHTML": "

team_slug parameter

" }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", + "name": "username", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "string" }, - "descriptionHTML": "

Page number of the results to fetch.

" + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/public_members', {\n org: 'org'\n})", - "html": "
await octokit.request('GET /orgs/{org}/public_members', {\n  org: 'org'\n})\n
" + "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/memberships/{username}', {\n org: 'org',\n team_slug: 'team_slug',\n username: 'username'\n})", + "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/memberships/{username}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  username: 'username'\n})\n
" } ], - "summary": "List public organization members", - "description": "Members of an organization can choose to have their membership publicized or not.", + "summary": "Get team membership for a user", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-team).", "tags": [ - "orgs" + "teams" ], - "operationId": "orgs/list-public-members", + "operationId": "teams/get-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#list-public-organization-members" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#get-team-membership-for-a-user" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "category": "orgs", + "category": "teams", "subcategory": "members" }, - "slug": "list-public-organization-members", - "category": "orgs", - "categoryLabel": "Orgs", + "slug": "get-team-membership-for-a-user", + "category": "teams", + "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Members of an organization can choose to have their membership publicized or not.

", + "descriptionHTML": "

Team members will include the members of child teams.

\n

To get a user's membership with a team, the team must be visible to the authenticated user.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.

\n

Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "Default response", - "payload": "
[\n  {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n]\n
" + "description": "Response if user has an active membership with team", + "payload": "
{\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
" + }, + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response if user is a team maintainer", + "payload": "
{\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"maintainer\",\n  \"state\": \"active\"\n}\n
" + }, + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response if user has a pending membership with team", + "payload": "
{\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"pending\"\n}\n
" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Response if user has no team membership" } ] }, { - "verb": "get", - "requestPath": "/orgs/{org}/public_members/{username}", + "verb": "put", + "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", "serverUrl": "https://api.github.com", "parameters": [ { @@ -13826,6 +21282,16 @@ }, "descriptionHTML": "" }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

team_slug parameter

" + }, { "name": "username", "in": "path", @@ -13839,56 +21305,109 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/public_members/{username}', {\n org: 'org',\n username: 'username'\n})", - "html": "
await octokit.request('GET /orgs/{org}/public_members/{username}', {\n  org: 'org',\n  username: 'username'\n})\n
" + "source": "await octokit.request('PUT /orgs/{org}/teams/{team_slug}/memberships/{username}', {\n org: 'org',\n team_slug: 'team_slug',\n username: 'username',\n role: 'role'\n})", + "html": "
await octokit.request('PUT /orgs/{org}/teams/{team_slug}/memberships/{username}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  username: 'username',\n  role: 'role'\n})\n
" } ], - "summary": "Check public organization membership for a user", - "description": "", + "summary": "Add or update team membership for a user", + "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\n**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 AE 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 AE](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ - "orgs" + "teams" ], - "operationId": "orgs/check-public-membership-for-user", + "operationId": "teams/add-or-update-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#check-public-organization-membership-for-a-user" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#add-or-update-team-membership-for-a-user" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "type": "string", + "description": "

The role that this user should have in the team. Can be one of:
\n* member - a normal member of the team.
\n* maintainer - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.

", + "enum": [ + "member", + "maintainer" + ], + "default": "member", + "name": "role", + "in": "body", + "rawType": "string", + "rawDescription": "The role that this user should have in the team. Can be one of: \n\\* `member` - a normal member of the team. \n\\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.", + "childParamsGroups": [] + } + } + } + } + } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "category": "orgs", + "category": "teams", "subcategory": "members" }, - "slug": "check-public-organization-membership-for-a-user", - "category": "orgs", - "categoryLabel": "Orgs", + "slug": "add-or-update-team-membership-for-a-user", + "category": "teams", + "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", "notes": [], + "descriptionHTML": "

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.

\n

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 AE 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 AE.\"

\n

An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.

\n

If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.

\n

Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.

", + "bodyParameters": [ + { + "type": "string", + "description": "

The role that this user should have in the team. Can be one of:
\n* member - a normal member of the team.
\n* maintainer - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.

", + "enum": [ + "member", + "maintainer" + ], + "default": "member", + "name": "role", + "in": "body", + "rawType": "string", + "rawDescription": "The role that this user should have in the team. Can be one of: \n\\* `member` - a normal member of the team. \n\\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.", + "childParamsGroups": [] + } + ], "responses": [ { - "httpStatusCode": "204", - "httpStatusMessage": "No Content", - "description": "Response if user is a public member" + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response if user's membership with team is now active", + "payload": "
{\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
" }, { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Response if user is not a public member" + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response if user's membership with team is now pending", + "payload": "
{\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"pending\"\n}\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if team synchronization is set up" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Response if you attempt to add an organization to a team", + "payload": "
{\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
" } - ], - "bodyParameters": [], - "descriptionHTML": "" + ] }, { - "verb": "put", - "requestPath": "/orgs/{org}/public_members/{username}", + "verb": "delete", + "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", "serverUrl": "https://api.github.com", "parameters": [ { @@ -13900,6 +21419,16 @@ }, "descriptionHTML": "" }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

team_slug parameter

" + }, { "name": "username", "in": "path", @@ -13913,35 +21442,35 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /orgs/{org}/public_members/{username}', {\n org: 'org',\n username: 'username'\n})", - "html": "
await octokit.request('PUT /orgs/{org}/public_members/{username}', {\n  org: 'org',\n  username: 'username'\n})\n
" + "source": "await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}', {\n org: 'org',\n team_slug: 'team_slug',\n username: 'username'\n})", + "html": "
await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  username: 'username'\n})\n
" } ], - "summary": "Set public organization membership for the authenticated user", - "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "summary": "Remove team membership for a user", + "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**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 AE 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 AE](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", "tags": [ - "orgs" + "teams" ], - "operationId": "orgs/set-public-membership-for-authenticated-user", + "operationId": "teams/remove-membership-for-user-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#remove-team-membership-for-a-user" }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "previews": [], - "category": "orgs", + "category": "teams", "subcategory": "members" }, - "slug": "set-public-organization-membership-for-the-authenticated-user", - "category": "orgs", - "categoryLabel": "Orgs", + "slug": "remove-team-membership-for-a-user", + "category": "teams", + "categoryLabel": "Teams", "subcategory": "members", "subcategoryLabel": "Members", "notes": [], @@ -13954,15 +21483,15 @@ { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Forbidden" + "description": "Response if team synchronization is set up" } ], "bodyParameters": [], - "descriptionHTML": "

The user can publicize their own membership. (A user cannot publicize the membership for another user.)

\n

Note that you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

" + "descriptionHTML": "

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

\n

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 AE 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 AE.\"

\n

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.

" }, { - "verb": "delete", - "requestPath": "/orgs/{org}/public_members/{username}", + "verb": "get", + "requestPath": "/orgs/{org}/teams/{team_slug}/projects", "serverUrl": "https://api.github.com", "parameters": [ { @@ -13975,63 +21504,90 @@ "descriptionHTML": "" }, { - "name": "username", + "name": "team_slug", + "description": "team_slug parameter", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "" + "descriptionHTML": "

team_slug parameter

" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/public_members/USERNAME", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/public_members/USERNAME
" + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /orgs/{org}/public_members/{username}', {\n org: 'org',\n username: 'username'\n})", - "html": "
await octokit.request('DELETE /orgs/{org}/public_members/{username}', {\n  org: 'org',\n  username: 'username'\n})\n
" + "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/projects', {\n org: 'org',\n team_slug: 'team_slug',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/projects', {\n  org: 'org',\n  team_slug: 'team_slug',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" } ], - "summary": "Remove public organization membership for the authenticated user", - "description": "", + "summary": "List team projects", + "description": "Lists the organization projects for a team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.", "tags": [ - "orgs" + "teams" ], - "operationId": "orgs/remove-public-membership-for-authenticated-user", + "operationId": "teams/list-projects-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#list-team-projects" }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, - "previews": [], - "category": "orgs", - "subcategory": "members" - }, - "slug": "remove-public-organization-membership-for-the-authenticated-user", - "category": "orgs", - "categoryLabel": "Orgs", - "subcategory": "members", - "subcategoryLabel": "Members", + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" + } + ], + "category": "teams", + "subcategory": null + }, + "slug": "list-team-projects", + "category": "teams", + "categoryLabel": "Teams", "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Lists the organization projects for a team.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects.

", "responses": [ { - "httpStatusCode": "204", - "httpStatusMessage": "No Content", - "description": "Default Response" + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
[\n  {\n    \"owner_url\": \"https://api.github.com/orgs/octocat\",\n    \"url\": \"https://api.github.com/projects/1002605\",\n    \"html_url\": \"https://github.com/orgs/api-playground/projects/1\",\n    \"columns_url\": \"https://api.github.com/projects/1002605/columns\",\n    \"id\": 1002605,\n    \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDU=\",\n    \"name\": \"Organization Roadmap\",\n    \"body\": \"High-level roadmap for the upcoming year.\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"created_at\": \"2011-04-11T20:09:31Z\",\n    \"updated_at\": \"2014-03-04T18:58:10Z\",\n    \"organization_permission\": \"write\",\n    \"private\": false,\n    \"permissions\": {\n      \"read\": true,\n      \"write\": true,\n      \"admin\": false\n    }\n  }\n]\n
" } - ], - "bodyParameters": [], - "descriptionHTML": "" + ] }, { "verb": "get", - "requestPath": "/orgs/{org}/repos", + "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", "serverUrl": "https://api.github.com", "parameters": [ { @@ -14044,136 +21600,84 @@ "descriptionHTML": "" }, { - "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "public", - "private", - "forks", - "sources", - "member", - "internal" - ] - }, - "descriptionHTML": "

Specifies the types of repositories you want returned. Can be one of all, public, private, forks, sources, member, internal. Default: all. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, type can also be internal.

" - }, - { - "name": "sort", - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "pushed", - "full_name" - ], - "default": "created" - }, - "descriptionHTML": "

Can be one of created, updated, pushed, full_name.

" - }, - { - "name": "direction", - "description": "Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc`", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ] - }, - "descriptionHTML": "

Can be one of asc or desc. Default: when using full_name: asc, otherwise desc

" - }, - { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "string" }, - "descriptionHTML": "

Results per page (max 100).

" + "descriptionHTML": "

team_slug parameter

" }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", + "name": "project_id", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" }, - "descriptionHTML": "

Page number of the results to fetch.

" + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/repos
" + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/repos', {\n org: 'org'\n})", - "html": "
await octokit.request('GET /orgs/{org}/repos', {\n  org: 'org'\n})\n
" + "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/projects/{project_id}', {\n org: 'org',\n team_slug: 'team_slug',\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/projects/{project_id}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  project_id: 42,\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" } ], - "summary": "List organization repositories", - "description": "Lists repositories for the specified organization.", + "summary": "Check team permissions for a project", + "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "tags": [ - "repos" + "teams" ], - "operationId": "repos/list-for-org", + "operationId": "teams/check-permissions-for-project-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#list-organization-repositories" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#check-team-permissions-for-a-project" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ { - "required": false, - "name": "nebula", - "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```", - "html": "

You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.

\n

To access repository visibility during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.nebula-preview+json
" - }, - { - "required": false, - "name": "baptiste", - "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```", - "html": "

The is_template and template_repository keys are currently available for developer to preview. See Create a repository using a template to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json
" + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" } ], - "category": "repos", + "category": "teams", "subcategory": null }, - "slug": "list-organization-repositories", - "category": "repos", - "categoryLabel": "Repos", + "slug": "check-team-permissions-for-a-project", + "category": "teams", + "categoryLabel": "Teams", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Lists repositories for the specified organization.

", + "descriptionHTML": "

Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects/{project_id}.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": false,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"template_repository\": {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World-Template\",\n      \"full_name\": \"octocat/Hello-World-Template\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World-Template\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World-Template\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World-Template.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World-Template.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World-Template.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World-Template\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World-Template\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks\": 9,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"watchers\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues\": 0,\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://api.github.com/licenses/mit\"\n      },\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0\n    }\n  }\n]\n
" + "payload": "
{\n  \"owner_url\": \"https://api.github.com/orgs/octocat\",\n  \"url\": \"https://api.github.com/projects/1002605\",\n  \"html_url\": \"https://github.com/orgs/api-playground/projects/1\",\n  \"columns_url\": \"https://api.github.com/projects/1002605/columns\",\n  \"id\": 1002605,\n  \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDU=\",\n  \"name\": \"Organization Roadmap\",\n  \"body\": \"High-level roadmap for the upcoming year.\",\n  \"number\": 1,\n  \"state\": \"open\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2011-04-11T20:09:31Z\",\n  \"updated_at\": \"2014-03-04T18:58:10Z\",\n  \"organization_permission\": \"write\",\n  \"private\": false,\n  \"permissions\": {\n    \"read\": true,\n    \"write\": true,\n    \"admin\": false\n  }\n}\n
" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Response if project is not managed by this team" } ] }, { - "verb": "post", - "requestPath": "/orgs/{org}/repos", + "verb": "put", + "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", "serverUrl": "https://api.github.com", "parameters": [ { @@ -14184,29 +21688,48 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

team_slug parameter

" + }, + { + "name": "project_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/repos \\\n -d '{\"name\":\"name\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/repos \\\n  -d '{\"name\":\"name\"}'
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42 \\\n -d '{\"permission\":\"permission\"}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /orgs/{org}/repos', {\n org: 'org',\n name: 'name'\n})", - "html": "
await octokit.request('POST /orgs/{org}/repos', {\n  org: 'org',\n  name: 'name'\n})\n
" + "source": "await octokit.request('PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}', {\n org: 'org',\n team_slug: 'team_slug',\n project_id: 42,\n permission: 'permission',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  project_id: 42,\n  permission: 'permission',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" } ], - "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "summary": "Add or update team project permissions", + "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "tags": [ - "repos" + "teams" ], - "operationId": "repos/create-in-org", + "operationId": "teams/add-or-update-project-permissions-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#create-an-organization-repository" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#add-or-update-team-project-permissions" }, "requestBody": { "content": { @@ -14214,188 +21737,22 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "

Required. The name of the repository.

", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "childParamsGroups": [] - }, - "description": { - "type": "string", - "description": "

A short description of the repository.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "childParamsGroups": [] - }, - "homepage": { - "type": "string", - "description": "

A URL with more information about the repository.

", - "name": "homepage", - "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "childParamsGroups": [] - }, - "private": { - "type": "boolean", - "description": "

Either true to create a private repository or false to create a public one.

", - "default": false, - "name": "private", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to create a private repository or `false` to create a public one.", - "childParamsGroups": [] - }, - "visibility": { + "permission": { "type": "string", - "description": "

Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
\nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

", + "description": "

The permission to grant to the team for this project. Can be one of:
\n* read - team members can read, but not write to or administer this project.
\n* write - team members can read and write, but not administer this project.
\n* admin - team members can read, write and administer this project.
\nDefault: the team's permission attribute will be used to determine what permission to grant the team on this project. 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.\"

", "enum": [ - "public", - "private", - "visibility", - "internal" + "read", + "write", + "admin" ], - "name": "visibility", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", - "childParamsGroups": [] - }, - "has_issues": { - "type": "boolean", - "description": "

Either true to enable issues for this repository or false to disable them.

", - "default": true, - "name": "has_issues", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", - "childParamsGroups": [] - }, - "has_projects": { - "type": "boolean", - "description": "

Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

", - "default": true, - "name": "has_projects", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "childParamsGroups": [] - }, - "has_wiki": { - "type": "boolean", - "description": "

Either true to enable the wiki for this repository or false to disable it.

", - "default": true, - "name": "has_wiki", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "childParamsGroups": [] - }, - "is_template": { - "type": "boolean", - "description": "

Either true to make this repo available as a template repository or false to prevent it.

", - "default": false, - "name": "is_template", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "childParamsGroups": [] - }, - "team_id": { - "type": "integer", - "description": "

The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

", - "name": "team_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "childParamsGroups": [] - }, - "auto_init": { - "type": "boolean", - "description": "

Pass true to create an initial commit with empty README.

", - "default": false, - "name": "auto_init", - "in": "body", - "rawType": "boolean", - "rawDescription": "Pass `true` to create an initial commit with empty README.", - "childParamsGroups": [] - }, - "gitignore_template": { - "type": "string", - "description": "

Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

", - "name": "gitignore_template", - "in": "body", - "rawType": "string", - "rawDescription": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", - "childParamsGroups": [] - }, - "license_template": { - "type": "string", - "description": "

Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

", - "name": "license_template", + "name": "permission", "in": "body", "rawType": "string", - "rawDescription": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", - "childParamsGroups": [] - }, - "allow_squash_merge": { - "type": "boolean", - "description": "

Either true to allow squash-merging pull requests, or false to prevent squash-merging.

", - "default": true, - "name": "allow_squash_merge", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "childParamsGroups": [] - }, - "allow_merge_commit": { - "type": "boolean", - "description": "

Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

", - "default": true, - "name": "allow_merge_commit", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "childParamsGroups": [] - }, - "allow_rebase_merge": { - "type": "boolean", - "description": "

Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

", - "default": true, - "name": "allow_rebase_merge", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "childParamsGroups": [] - }, - "delete_branch_on_merge": { - "type": "boolean", - "description": "

Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

", - "default": false, - "name": "delete_branch_on_merge", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", + "rawDescription": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. 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](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"", "childParamsGroups": [] } }, - "required": [ - "name" - ] - }, - "example": { - "name": "Hello-World", - "description": "This is your first repository", - "homepage": "https://github.com", - "private": false, - "has_issues": true, - "has_projects": true, - "has_wiki": true + "nullable": true } } } @@ -14405,219 +21762,53 @@ "enabledForGitHubApps": true, "previews": [ { - "required": false, - "name": "nebula", - "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```", - "html": "

You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.

\n

To access repository visibility during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.nebula-preview+json
" - }, - { - "required": false, - "name": "baptiste", - "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```", - "html": "

The is_template and template_repository keys are currently available for developer to preview. See Create a repository using a template to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json
" + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" } ], - "category": "repos", + "category": "teams", "subcategory": null }, - "slug": "create-an-organization-repository", - "category": "repos", - "categoryLabel": "Repos", - "notes": [], - "descriptionHTML": "

Creates a new repository in the specified organization. The authenticated user must be a member of the organization.

\n

OAuth scope requirements

\n

When using OAuth, authorizations must include:

\n
    \n
  • public_repo scope or repo scope to create a public repository
    • \n
  • repo scope to create a private repository
    • \n
", - "bodyParameters": [ - { - "type": "string", - "description": "

Required. The name of the repository.

", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

A short description of the repository.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

A URL with more information about the repository.

", - "name": "homepage", - "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "childParamsGroups": [] - }, - { - "type": "boolean", - "description": "

Either true to create a private repository or false to create a public one.

", - "default": false, - "name": "private", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to create a private repository or `false` to create a public one.", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. For more information, see \"Creating an internal repository\" in the GitHub Help documentation.
\nThe visibility parameter overrides the private parameter when you use both parameters with the nebula-preview preview header.

", - "enum": [ - "public", - "private", - "visibility", - "internal" - ], - "name": "visibility", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", - "childParamsGroups": [] - }, - { - "type": "boolean", - "description": "

Either true to enable issues for this repository or false to disable them.

", - "default": true, - "name": "has_issues", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", - "childParamsGroups": [] - }, - { - "type": "boolean", - "description": "

Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

", - "default": true, - "name": "has_projects", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "childParamsGroups": [] - }, - { - "type": "boolean", - "description": "

Either true to enable the wiki for this repository or false to disable it.

", - "default": true, - "name": "has_wiki", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "childParamsGroups": [] - }, - { - "type": "boolean", - "description": "

Either true to make this repo available as a template repository or false to prevent it.

", - "default": false, - "name": "is_template", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "childParamsGroups": [] - }, - { - "type": "integer", - "description": "

The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.

", - "name": "team_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization.", - "childParamsGroups": [] - }, - { - "type": "boolean", - "description": "

Pass true to create an initial commit with empty README.

", - "default": false, - "name": "auto_init", - "in": "body", - "rawType": "boolean", - "rawDescription": "Pass `true` to create an initial commit with empty README.", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

Desired language or platform .gitignore template to apply. Use the name of the template without the extension. For example, \"Haskell\".

", - "name": "gitignore_template", - "in": "body", - "rawType": "string", - "rawDescription": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\".", - "childParamsGroups": [] - }, + "slug": "add-or-update-team-project-permissions", + "category": "teams", + "categoryLabel": "Teams", + "notes": [], + "descriptionHTML": "

Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.

\n

Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}.

", + "bodyParameters": [ { "type": "string", - "description": "

Choose an open source license template that best suits your needs, and then use the license keyword as the license_template string. For example, \"mit\" or \"mpl-2.0\".

", - "name": "license_template", + "description": "

The permission to grant to the team for this project. Can be one of:
\n* read - team members can read, but not write to or administer this project.
\n* write - team members can read and write, but not administer this project.
\n* admin - team members can read, write and administer this project.
\nDefault: the team's permission attribute will be used to determine what permission to grant the team on this project. 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.\"

", + "enum": [ + "read", + "write", + "admin" + ], + "name": "permission", "in": "body", "rawType": "string", - "rawDescription": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\".", - "childParamsGroups": [] - }, - { - "type": "boolean", - "description": "

Either true to allow squash-merging pull requests, or false to prevent squash-merging.

", - "default": true, - "name": "allow_squash_merge", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "childParamsGroups": [] - }, - { - "type": "boolean", - "description": "

Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

", - "default": true, - "name": "allow_merge_commit", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "childParamsGroups": [] - }, - { - "type": "boolean", - "description": "

Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

", - "default": true, - "name": "allow_rebase_merge", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "childParamsGroups": [] - }, - { - "type": "boolean", - "description": "

Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

", - "default": false, - "name": "delete_branch_on_merge", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", + "rawDescription": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. 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](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"", "childParamsGroups": [] } ], "responses": [ { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Default response", - "payload": "
{\n  \"id\": 1296269,\n  \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n  \"name\": \"Hello-World\",\n  \"full_name\": \"octocat/Hello-World\",\n  \"owner\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"private\": false,\n  \"html_url\": \"https://github.com/octocat/Hello-World\",\n  \"description\": \"This your first repo!\",\n  \"fork\": false,\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n  \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n  \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n  \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n  \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n  \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n  \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n  \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n  \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n  \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n  \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n  \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n  \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n  \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n  \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n  \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n  \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n  \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n  \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n  \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n  \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n  \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n  \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n  \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n  \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n  \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n  \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n  \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n  \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n  \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n  \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n  \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n  \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n  \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n  \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n  \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n  \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n  \"homepage\": \"https://github.com\",\n  \"language\": null,\n  \"forks\": 9,\n  \"forks_count\": 9,\n  \"stargazers_count\": 80,\n  \"watchers_count\": 80,\n  \"watchers\": 80,\n  \"size\": 108,\n  \"default_branch\": \"master\",\n  \"open_issues\": 0,\n  \"open_issues_count\": 0,\n  \"is_template\": true,\n  \"license\": {\n    \"key\": \"mit\",\n    \"name\": \"MIT License\",\n    \"url\": \"https://api.github.com/licenses/mit\",\n    \"spdx_id\": \"MIT\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n    \"html_url\": \"https://api.github.com/licenses/mit\"\n  },\n  \"topics\": [\n    \"octocat\",\n    \"atom\",\n    \"electron\",\n    \"api\"\n  ],\n  \"has_issues\": true,\n  \"has_projects\": true,\n  \"has_wiki\": true,\n  \"has_pages\": false,\n  \"has_downloads\": true,\n  \"archived\": false,\n  \"disabled\": false,\n  \"visibility\": \"public\",\n  \"pushed_at\": \"2011-01-26T19:06:43Z\",\n  \"created_at\": \"2011-01-26T19:01:12Z\",\n  \"updated_at\": \"2011-01-26T19:14:43Z\",\n  \"permissions\": {\n    \"admin\": false,\n    \"push\": false,\n    \"pull\": true\n  },\n  \"allow_rebase_merge\": true,\n  \"template_repository\": null,\n  \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n  \"allow_squash_merge\": true,\n  \"delete_branch_on_merge\": true,\n  \"allow_merge_commit\": true,\n  \"subscribers_count\": 42,\n  \"network_count\": 0\n}\n
" + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" }, { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "description": "Response if the project is not owned by the organization", + "payload": "
{\n  \"message\": \"Must have admin rights to Repository.\",\n  \"documentation_url\": \"https://docs.github.com/github-ae@latest/rest/reference/teams#add-or-update-team-project-permissions\"\n}\n
" } ] }, { - "verb": "get", - "requestPath": "/orgs/{org}/teams", + "verb": "delete", + "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", "serverUrl": "https://api.github.com", "parameters": [ { @@ -14630,47 +21821,46 @@ "descriptionHTML": "" }, { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "string" }, - "descriptionHTML": "

Results per page (max 100).

" + "descriptionHTML": "

team_slug parameter

" }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", + "name": "project_id", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" }, - "descriptionHTML": "

Page number of the results to fetch.

" + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/teams', {\n org: 'org'\n})", - "html": "
await octokit.request('GET /orgs/{org}/teams', {\n  org: 'org'\n})\n
" + "source": "await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}', {\n org: 'org',\n team_slug: 'team_slug',\n project_id: 42\n})", + "html": "
await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  project_id: 42\n})\n
" } ], - "summary": "List teams", - "description": "Lists all teams in an organization that are visible to the authenticated user.", + "summary": "Remove a project from a team", + "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", "tags": [ "teams" ], - "operationId": "teams/list", + "operationId": "teams/remove-project-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#list-teams" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#remove-a-project-from-a-team" }, "x-github": { "githubCloudOnly": false, @@ -14679,29 +21869,23 @@ "category": "teams", "subcategory": null }, - "slug": "list-teams", + "slug": "remove-a-project-from-a-team", "category": "teams", "categoryLabel": "Teams", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Lists all teams in an organization that are visible to the authenticated user.

", "responses": [ { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Default response", - "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDQ6VGVhbTE=\",\n    \"url\": \"https://api.github.com/teams/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n    \"name\": \"Justice League\",\n    \"slug\": \"justice-league\",\n    \"description\": \"A great team.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n    \"parent\": null\n  }\n]\n
" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. This endpoint removes the project from the team, but does not delete the project.

\n

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}.

" }, { - "verb": "post", - "requestPath": "/orgs/{org}/teams", + "verb": "get", + "requestPath": "/orgs/{org}/teams/{team_slug}/repos", "serverUrl": "https://api.github.com", "parameters": [ { @@ -14712,128 +21896,59 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

team_slug parameter

" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams \\\n -d '{\"name\":\"name\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams \\\n  -d '{\"name\":\"name\"}'
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /orgs/{org}/teams', {\n org: 'org',\n name: 'name'\n})", - "html": "
await octokit.request('POST /orgs/{org}/teams', {\n  org: 'org',\n  name: 'name'\n})\n
" + "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/repos', {\n org: 'org',\n team_slug: 'team_slug'\n})", + "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/repos', {\n  org: 'org',\n  team_slug: 'team_slug'\n})\n
" } ], - "summary": "Create a team", - "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", + "summary": "List team repositories", + "description": "Lists a team's repositories visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", "tags": [ "teams" ], - "operationId": "teams/create", + "operationId": "teams/list-repos-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#create-a-team" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "

Required. The name of the team.

", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "childParamsGroups": [] - }, - "description": { - "type": "string", - "description": "

The description of the team.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "childParamsGroups": [] - }, - "maintainers": { - "type": "array of strings", - "description": "

List GitHub IDs for organization members who will become team maintainers.

", - "items": { - "type": "string" - }, - "name": "maintainers", - "in": "body", - "rawType": "array", - "rawDescription": "List GitHub IDs for organization members who will become team maintainers.", - "childParamsGroups": [] - }, - "repo_names": { - "type": "array of strings", - "description": "

The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

", - "items": { - "type": "string" - }, - "name": "repo_names", - "in": "body", - "rawType": "array", - "rawDescription": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", - "childParamsGroups": [] - }, - "privacy": { - "type": "string", - "description": "

The level of privacy this team should have. The options are:
\nFor a non-nested team:
\n* secret - only visible to organization owners and members of this team.
\n* closed - visible to all members of this organization.
\nDefault: secret
\nFor a parent or child team:
\n* closed - visible to all members of this organization.
\nDefault for child team: closed

", - "enum": [ - "secret", - "closed" - ], - "name": "privacy", - "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", - "childParamsGroups": [] - }, - "permission": { - "type": "string", - "description": "

Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of:
\n* pull - team members can pull, but not push to or administer newly-added repositories.
\n* push - team members can pull and push, but not administer newly-added repositories.
\n* admin - team members can pull, push and administer newly-added repositories.

", - "enum": [ - "pull", - "push", - "admin" - ], - "default": "pull", - "name": "permission", - "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", - "childParamsGroups": [] - }, - "parent_team_id": { - "type": "integer", - "description": "

The ID of a team to set as the parent team.

", - "name": "parent_team_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of a team to set as the parent team.", - "childParamsGroups": [] - } - }, - "required": [ - "name" - ] - }, - "example": { - "name": "Justice League", - "description": "A great team", - "permission": "admin", - "privacy": "closed" - } - } - } + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#list-team-repositories" }, "x-github": { "githubCloudOnly": false, @@ -14842,114 +21957,24 @@ "category": "teams", "subcategory": null }, - "slug": "create-a-team", + "slug": "list-team-repositories", "category": "teams", "categoryLabel": "Teams", "notes": [], - "descriptionHTML": "

To create a team, the authenticated user must be a member or owner of {org}. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"Setting team creation permissions.\"

\n

When you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of maintainers. For more information, see \"About teams\".

", - "bodyParameters": [ - { - "type": "string", - "description": "

Required. The name of the team.

", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

The description of the team.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "childParamsGroups": [] - }, - { - "type": "array of strings", - "description": "

List GitHub IDs for organization members who will become team maintainers.

", - "items": { - "type": "string" - }, - "name": "maintainers", - "in": "body", - "rawType": "array", - "rawDescription": "List GitHub IDs for organization members who will become team maintainers.", - "childParamsGroups": [] - }, - { - "type": "array of strings", - "description": "

The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.

", - "items": { - "type": "string" - }, - "name": "repo_names", - "in": "body", - "rawType": "array", - "rawDescription": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

The level of privacy this team should have. The options are:
\nFor a non-nested team:
\n* secret - only visible to organization owners and members of this team.
\n* closed - visible to all members of this organization.
\nDefault: secret
\nFor a parent or child team:
\n* closed - visible to all members of this organization.
\nDefault for child team: closed

", - "enum": [ - "secret", - "closed" - ], - "name": "privacy", - "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of:
\n* pull - team members can pull, but not push to or administer newly-added repositories.
\n* push - team members can pull and push, but not administer newly-added repositories.
\n* admin - team members can pull, push and administer newly-added repositories.

", - "enum": [ - "pull", - "push", - "admin" - ], - "default": "pull", - "name": "permission", - "in": "body", - "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", - "childParamsGroups": [] - }, - { - "type": "integer", - "description": "

The ID of a team to set as the parent team.

", - "name": "parent_team_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of a team to set as the parent team.", - "childParamsGroups": [] - } - ], + "bodyParameters": [], + "descriptionHTML": "

Lists a team's repositories visible to the authenticated user.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.

", "responses": [ { - "httpStatusCode": "201", - "httpStatusMessage": "Created", + "httpStatusCode": "200", + "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDQ6VGVhbTE=\",\n  \"url\": \"https://api.github.com/teams/1\",\n  \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n  \"name\": \"Justice League\",\n  \"slug\": \"justice-league\",\n  \"description\": \"A great team.\",\n  \"privacy\": \"closed\",\n  \"permission\": \"admin\",\n  \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n  \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n  \"parent\": null,\n  \"members_count\": 3,\n  \"repos_count\": 10,\n  \"created_at\": \"2017-07-14T16:53:42Z\",\n  \"updated_at\": \"2017-08-17T12:37:15Z\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\",\n    \"name\": \"github\",\n    \"company\": \"GitHub\",\n    \"blog\": \"https://github.com/blog\",\n    \"location\": \"San Francisco\",\n    \"email\": \"octocat@github.com\",\n    \"is_verified\": true,\n    \"has_organization_projects\": true,\n    \"has_repository_projects\": true,\n    \"public_repos\": 2,\n    \"public_gists\": 1,\n    \"followers\": 20,\n    \"following\": 0,\n    \"html_url\": \"https://github.com/octocat\",\n    \"created_at\": \"2008-01-14T04:33:35Z\",\n    \"updated_at\": \"2017-08-17T12:37:15Z\",\n    \"type\": \"Organization\"\n  }\n}\n
" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "payload": "
[\n  {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": false,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"template_repository\": {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World-Template\",\n      \"full_name\": \"octocat/Hello-World-Template\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World-Template\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World-Template\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World-Template.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World-Template.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World-Template.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World-Template\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World-Template\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks\": 9,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"watchers\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues\": 0,\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://api.github.com/licenses/mit\"\n      },\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0\n    }\n  }\n]\n
" } ] }, { "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}", + "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "serverUrl": "https://api.github.com", "parameters": [ { @@ -14970,29 +21995,47 @@ "type": "string" }, "descriptionHTML": "

team_slug parameter

" + }, + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}', {\n org: 'org',\n team_slug: 'team_slug'\n})", - "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}', {\n  org: 'org',\n  team_slug: 'team_slug'\n})\n
" + "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}', {\n org: 'org',\n team_slug: 'team_slug',\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" } ], - "summary": "Get a team by name", - "description": "Gets a team using the team's `slug`. GitHub AE generates the `slug` from the team `name`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", + "summary": "Check team permissions for a repository", + "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ "teams" ], - "operationId": "teams/get-by-name", + "operationId": "teams/check-permissions-for-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#get-a-team-by-name" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#check-team-permissions-for-a-repository" }, "x-github": { "githubCloudOnly": false, @@ -15001,29 +22044,33 @@ "category": "teams", "subcategory": null }, - "slug": "get-a-team-by-name", + "slug": "check-team-permissions-for-a-repository", "category": "teams", "categoryLabel": "Teams", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Gets a team using the team's slug. GitHub AE generates the slug from the team name.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "Default response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDQ6VGVhbTE=\",\n  \"url\": \"https://api.github.com/teams/1\",\n  \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n  \"name\": \"Justice League\",\n  \"slug\": \"justice-league\",\n  \"description\": \"A great team.\",\n  \"privacy\": \"closed\",\n  \"permission\": \"admin\",\n  \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n  \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n  \"parent\": null,\n  \"members_count\": 3,\n  \"repos_count\": 10,\n  \"created_at\": \"2017-07-14T16:53:42Z\",\n  \"updated_at\": \"2017-08-17T12:37:15Z\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\",\n    \"name\": \"github\",\n    \"company\": \"GitHub\",\n    \"blog\": \"https://github.com/blog\",\n    \"location\": \"San Francisco\",\n    \"email\": \"octocat@github.com\",\n    \"is_verified\": true,\n    \"has_organization_projects\": true,\n    \"has_repository_projects\": true,\n    \"public_repos\": 2,\n    \"public_gists\": 1,\n    \"followers\": 20,\n    \"following\": 0,\n    \"html_url\": \"https://github.com/octocat\",\n    \"created_at\": \"2008-01-14T04:33:35Z\",\n    \"updated_at\": \"2017-08-17T12:37:15Z\",\n    \"type\": \"Organization\"\n  }\n}\n
" + "description": "Alternative response with repository permissions" + }, + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response if team has permission for the repository" }, { "httpStatusCode": "404", "httpStatusMessage": "Not Found", - "description": "Resource not found" + "description": "Response if team does not have permission for the repository" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.

\n

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.

\n

If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.

" }, { - "verb": "patch", - "requestPath": "/orgs/{org}/teams/{team_slug}", + "verb": "put", + "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "serverUrl": "https://api.github.com", "parameters": [ { @@ -15044,98 +22091,71 @@ "type": "string" }, "descriptionHTML": "

team_slug parameter

" + }, + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG \\\n -d '{\"name\":\"name\"}'", - "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG \\\n  -d '{\"name\":\"name\"}'
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PATCH /orgs/{org}/teams/{team_slug}', {\n org: 'org',\n team_slug: 'team_slug',\n name: 'name'\n})", - "html": "
await octokit.request('PATCH /orgs/{org}/teams/{team_slug}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  name: 'name'\n})\n
" + "source": "await octokit.request('PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}', {\n org: 'org',\n team_slug: 'team_slug',\n owner: 'octocat',\n repo: 'hello-world',\n permission: 'permission'\n})", + "html": "
await octokit.request('PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  owner: 'octocat',\n  repo: 'hello-world',\n  permission: 'permission'\n})\n
" } ], - "summary": "Update a team", - "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", + "summary": "Add or update team repository permissions", + "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", "tags": [ "teams" ], - "operationId": "teams/update-in-org", + "operationId": "teams/add-or-update-repo-permissions-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#update-a-team" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "

The name of the team.

", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "childParamsGroups": [] - }, - "description": { - "type": "string", - "description": "

The description of the team.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "childParamsGroups": [] - }, - "privacy": { - "type": "string", - "description": "

The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
\n* secret - only visible to organization owners and members of this team.
\n* closed - visible to all members of this organization.
\nFor a parent or child team:
\n* closed - visible to all members of this organization.

", - "enum": [ - "secret", - "closed" - ], - "name": "privacy", - "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "childParamsGroups": [] - }, + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#add-or-update-team-repository-permissions" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { "permission": { "type": "string", - "description": "

Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of:
\n* pull - team members can pull, but not push to or administer newly-added repositories.
\n* push - team members can pull and push, but not administer newly-added repositories.
\n* admin - team members can pull, push and administer newly-added repositories.

", + "description": "

The permission to grant the team on this repository. Can be one of:
\n* pull - team members can pull, but not push to or administer this repository.
\n* push - team members can pull and push, but not administer this repository.
\n* admin - team members can pull, push and administer this repository.
\n* maintain - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations.
\n* triage - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations.

\n

If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

", "enum": [ "pull", "push", - "admin" + "admin", + "maintain", + "triage" ], - "default": "pull", "name": "permission", "in": "body", "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", - "childParamsGroups": [] - }, - "parent_team_id": { - "type": "integer or null", - "description": "

The ID of a team to set as the parent team.

", - "nullable": true, - "name": "parent_team_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of a team to set as the parent team.", + "rawDescription": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n\\* `maintain` - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations. \n\\* `triage` - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", "childParamsGroups": [] } } - }, - "example": { - "name": "new team name", - "description": "new team description", - "privacy": "closed" } } } @@ -15147,81 +22167,40 @@ "category": "teams", "subcategory": null }, - "slug": "update-a-team", + "slug": "add-or-update-team-repository-permissions", "category": "teams", "categoryLabel": "Teams", "notes": [], - "descriptionHTML": "

To edit a team, the authenticated user must either be an organization owner or a team maintainer.

\n

Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}.

", - "bodyParameters": [ - { - "type": "string", - "description": "

The name of the team.

", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the team.", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

The description of the team.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "The description of the team.", - "childParamsGroups": [] - }, + "responses": [ { - "type": "string", - "description": "

The level of privacy this team should have. Editing teams without specifying this parameter leaves privacy intact. When a team is nested, the privacy for parent teams cannot be secret. The options are:
\nFor a non-nested team:
\n* secret - only visible to organization owners and members of this team.
\n* closed - visible to all members of this organization.
\nFor a parent or child team:
\n* closed - visible to all members of this organization.

", - "enum": [ - "secret", - "closed" - ], - "name": "privacy", - "in": "body", - "rawType": "string", - "rawDescription": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "childParamsGroups": [] - }, + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "descriptionHTML": "

To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.

\n

For more information about the permission levels, see \"Repository permission levels for an organization\".

", + "bodyParameters": [ { "type": "string", - "description": "

Deprecated. The permission that new repositories will be added to the team with when none is specified. Can be one of:
\n* pull - team members can pull, but not push to or administer newly-added repositories.
\n* push - team members can pull and push, but not administer newly-added repositories.
\n* admin - team members can pull, push and administer newly-added repositories.

", + "description": "

The permission to grant the team on this repository. Can be one of:
\n* pull - team members can pull, but not push to or administer this repository.
\n* push - team members can pull and push, but not administer this repository.
\n* admin - team members can pull, push and administer this repository.
\n* maintain - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations.
\n* triage - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations.

\n

If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

", "enum": [ "pull", "push", - "admin" + "admin", + "maintain", + "triage" ], - "default": "pull", "name": "permission", "in": "body", "rawType": "string", - "rawDescription": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", - "childParamsGroups": [] - }, - { - "type": "integer or null", - "description": "

The ID of a team to set as the parent team.

", - "nullable": true, - "name": "parent_team_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The ID of a team to set as the parent team.", + "rawDescription": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n\\* `maintain` - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations. \n\\* `triage` - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Default response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDQ6VGVhbTE=\",\n  \"url\": \"https://api.github.com/teams/1\",\n  \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n  \"name\": \"Justice League\",\n  \"slug\": \"justice-league\",\n  \"description\": \"A great team.\",\n  \"privacy\": \"closed\",\n  \"permission\": \"admin\",\n  \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n  \"repositories_url\": \"https://api.github.com/teams/1/repos\",\n  \"parent\": null,\n  \"members_count\": 3,\n  \"repos_count\": 10,\n  \"created_at\": \"2017-07-14T16:53:42Z\",\n  \"updated_at\": \"2017-08-17T12:37:15Z\",\n  \"organization\": {\n    \"login\": \"github\",\n    \"id\": 1,\n    \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n    \"url\": \"https://api.github.com/orgs/github\",\n    \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n    \"events_url\": \"https://api.github.com/orgs/github/events\",\n    \"hooks_url\": \"https://api.github.com/orgs/github/hooks\",\n    \"issues_url\": \"https://api.github.com/orgs/github/issues\",\n    \"members_url\": \"https://api.github.com/orgs/github/members{/member}\",\n    \"public_members_url\": \"https://api.github.com/orgs/github/public_members{/member}\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"description\": \"A great organization\",\n    \"name\": \"github\",\n    \"company\": \"GitHub\",\n    \"blog\": \"https://github.com/blog\",\n    \"location\": \"San Francisco\",\n    \"email\": \"octocat@github.com\",\n    \"is_verified\": true,\n    \"has_organization_projects\": true,\n    \"has_repository_projects\": true,\n    \"public_repos\": 2,\n    \"public_gists\": 1,\n    \"followers\": 20,\n    \"following\": 0,\n    \"html_url\": \"https://github.com/octocat\",\n    \"created_at\": \"2008-01-14T04:33:35Z\",\n    \"updated_at\": \"2017-08-17T12:37:15Z\",\n    \"type\": \"Organization\"\n  }\n}\n
" - } ] }, { "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}", + "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", "serverUrl": "https://api.github.com", "parameters": [ { @@ -15242,29 +22221,47 @@ "type": "string" }, "descriptionHTML": "

team_slug parameter

" + }, + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /orgs/{org}/teams/{team_slug}', {\n org: 'org',\n team_slug: 'team_slug'\n})", - "html": "
await octokit.request('DELETE /orgs/{org}/teams/{team_slug}', {\n  org: 'org',\n  team_slug: 'team_slug'\n})\n
" + "source": "await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}', {\n org: 'org',\n team_slug: 'team_slug',\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" } ], - "summary": "Delete a team", - "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", + "summary": "Remove a repository from a team", + "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ "teams" ], - "operationId": "teams/delete-in-org", + "operationId": "teams/remove-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#delete-a-team" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#remove-a-repository-from-a-team" }, "x-github": { "githubCloudOnly": false, @@ -15273,7 +22270,7 @@ "category": "teams", "subcategory": null }, - "slug": "delete-a-team", + "slug": "remove-a-repository-from-a-team", "category": "teams", "categoryLabel": "Teams", "notes": [], @@ -15285,11 +22282,11 @@ } ], "bodyParameters": [], - "descriptionHTML": "

To delete a team, the authenticated user must be an organization owner or team maintainer.

\n

If you are an organization owner, deleting a parent team will delete all of its child teams as well.

\n

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}.

" + "descriptionHTML": "

If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.

\n

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.

" }, { "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/discussions", + "requestPath": "/orgs/{org}/teams/{team_slug}/teams", "serverUrl": "https://api.github.com", "parameters": [ { @@ -15311,21 +22308,6 @@ }, "descriptionHTML": "

team_slug parameter

" }, - { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - }, - "descriptionHTML": "

One of asc (ascending) or desc (descending).

" - }, { "name": "per_page", "description": "Results per page (max 100).", @@ -15350,382 +22332,669 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/teams", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/teams
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions', {\n org: 'org',\n team_slug: 'team_slug'\n})", - "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions', {\n  org: 'org',\n  team_slug: 'team_slug'\n})\n
" + "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/teams', {\n org: 'org',\n team_slug: 'team_slug'\n})", + "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/teams', {\n  org: 'org',\n  team_slug: 'team_slug'\n})\n
" } ], - "summary": "List discussions", - "description": "List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.", + "summary": "List child teams", + "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", "tags": [ "teams" ], - "operationId": "teams/list-discussions-in-org", + "operationId": "teams/list-child-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#list-discussions" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#list-child-teams" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "teams", + "subcategory": null + }, + "slug": "list-child-teams", + "category": "teams", + "categoryLabel": "Teams", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Lists the child teams of the team specified by {team_slug}.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response if child teams exist", + "payload": "
[\n  {\n    \"id\": 2,\n    \"node_id\": \"MDQ6VGVhbTI=\",\n    \"url\": \"https://api.github.com/teams/2\",\n    \"name\": \"Original Roster\",\n    \"slug\": \"original-roster\",\n    \"description\": \"Started it all.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/2/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/2/repos\",\n    \"parent\": {\n      \"id\": 1,\n      \"node_id\": \"MDQ6VGVhbTE=\",\n      \"url\": \"https://api.github.com/teams/1\",\n      \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n      \"name\": \"Justice League\",\n      \"slug\": \"justice-league\",\n      \"description\": \"A great team.\",\n      \"privacy\": \"closed\",\n      \"permission\": \"admin\",\n      \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n      \"repositories_url\": \"https://api.github.com/teams/1/repos\"\n    },\n    \"html_url\": \"https://github.com/orgs/rails/teams/core\"\n  }\n]\n
" + } + ] + }, + { + "verb": "get", + "requestPath": "/projects/columns/cards/{card_id}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "card_id", + "description": "card_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

card_id parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /projects/columns/cards/{card_id}', {\n card_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('GET /projects/columns/cards/{card_id}', {\n  card_id: 42,\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + } + ], + "summary": "Get a project card", + "description": "", + "tags": [ + "projects" + ], + "operationId": "projects/get-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#get-a-project-card" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ { - "required": false, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", - "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" } ], - "category": "teams", - "subcategory": "discussions" + "category": "projects", + "subcategory": "cards" }, - "slug": "list-discussions", - "category": "teams", - "categoryLabel": "Teams", - "subcategory": "discussions", - "subcategoryLabel": "Discussions", + "slug": "get-a-project-card", + "category": "projects", + "categoryLabel": "Projects", + "subcategory": "cards", + "subcategoryLabel": "Cards", "notes": [], "bodyParameters": [], - "descriptionHTML": "

List all discussions on a team's page. OAuth access tokens require the read:discussion scope.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions.

", + "descriptionHTML": "", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"author\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"body\": \"Hi! This is an area for us to collaborate as a team.\",\n    \"body_html\": \"<p>Hi! This is an area for us to collaborate as a team</p>\",\n    \"body_version\": \"0d495416a700fb06133c612575d92bfb\",\n    \"comments_count\": 0,\n    \"comments_url\": \"https://api.github.com/teams/2343027/discussions/1/comments\",\n    \"created_at\": \"2018-01-25T18:56:31Z\",\n    \"last_edited_at\": null,\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1\",\n    \"node_id\": \"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\n    \"number\": 1,\n    \"pinned\": false,\n    \"private\": false,\n    \"team_url\": \"https://api.github.com/teams/2343027\",\n    \"title\": \"Our first team post\",\n    \"updated_at\": \"2018-01-25T18:56:31Z\",\n    \"url\": \"https://api.github.com/teams/2343027/discussions/1\",\n    \"reactions\": {\n      \"url\": \"https://api.github.com/teams/2343027/discussions/1/reactions\",\n      \"total_count\": 5,\n      \"+1\": 3,\n      \"-1\": 1,\n      \"laugh\": 0,\n      \"confused\": 0,\n      \"heart\": 1,\n      \"hooray\": 0,\n      \"eyes\": 1,\n      \"rocket\": 1\n    }\n  }\n]\n
" + "payload": "
{\n  \"url\": \"https://api.github.com/projects/columns/cards/1478\",\n  \"id\": 1478,\n  \"node_id\": \"MDExOlByb2plY3RDYXJkMTQ3OA==\",\n  \"note\": \"Add payload for delete Project column\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2016-09-05T14:21:06Z\",\n  \"updated_at\": \"2016-09-05T14:20:22Z\",\n  \"archived\": false,\n  \"column_url\": \"https://api.github.com/projects/columns/367\",\n  \"content_url\": \"https://api.github.com/repos/api-playground/projects-test/issues/3\",\n  \"project_url\": \"https://api.github.com/projects/120\"\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + } + ] + }, + { + "verb": "patch", + "requestPath": "/projects/columns/cards/{card_id}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "card_id", + "description": "card_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

card_id parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42 \\\n -d '{\"note\":\"note\"}'", + "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42 \\\n  -d '{\"note\":\"note\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PATCH /projects/columns/cards/{card_id}', {\n card_id: 42,\n note: 'note',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('PATCH /projects/columns/cards/{card_id}', {\n  card_id: 42,\n  note: 'note',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + } + ], + "summary": "Update an existing project card", + "description": "", + "tags": [ + "projects" + ], + "operationId": "projects/update-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#update-a-project-card" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "note": { + "description": "

The project card's note

", + "example": "Update all gems", + "type": "string or null", + "nullable": true, + "name": "note", + "in": "body", + "rawType": "string", + "rawDescription": "The project card's note", + "childParamsGroups": [] + }, + "archived": { + "description": "

Whether or not the card is archived

", + "example": false, + "type": "boolean", + "name": "archived", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether or not the card is archived", + "childParamsGroups": [] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" + } + ], + "category": "projects", + "subcategory": "cards" + }, + "slug": "update-an-existing-project-card", + "category": "projects", + "categoryLabel": "Projects", + "subcategory": "cards", + "subcategoryLabel": "Cards", + "notes": [], + "descriptionHTML": "", + "bodyParameters": [ + { + "description": "

The project card's note

", + "example": "Update all gems", + "type": "string or null", + "nullable": true, + "name": "note", + "in": "body", + "rawType": "string", + "rawDescription": "The project card's note", + "childParamsGroups": [] + }, + { + "description": "

Whether or not the card is archived

", + "example": false, + "type": "boolean", + "name": "archived", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether or not the card is archived", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"url\": \"https://api.github.com/projects/columns/cards/1478\",\n  \"id\": 1478,\n  \"node_id\": \"MDExOlByb2plY3RDYXJkMTQ3OA==\",\n  \"note\": \"Add payload for delete Project column\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2016-09-05T14:21:06Z\",\n  \"updated_at\": \"2016-09-05T14:20:22Z\",\n  \"archived\": false,\n  \"column_url\": \"https://api.github.com/projects/columns/367\",\n  \"content_url\": \"https://api.github.com/repos/api-playground/projects-test/issues/3\",\n  \"project_url\": \"https://api.github.com/projects/120\"\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, + { + "verb": "delete", + "requestPath": "/projects/columns/cards/{card_id}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "card_id", + "description": "card_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

card_id parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /projects/columns/cards/{card_id}', {\n card_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('DELETE /projects/columns/cards/{card_id}', {\n  card_id: 42,\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + } + ], + "summary": "Delete a project card", + "description": "", + "tags": [ + "projects" + ], + "operationId": "projects/delete-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#delete-a-project-card" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" + } + ], + "category": "projects", + "subcategory": "cards" + }, + "slug": "delete-a-project-card", + "category": "projects", + "categoryLabel": "Projects", + "subcategory": "cards", + "subcategoryLabel": "Cards", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "" }, { "verb": "post", - "requestPath": "/orgs/{org}/teams/{team_slug}/discussions", + "requestPath": "/projects/columns/cards/{card_id}/moves", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "team_slug", - "description": "team_slug parameter", + "name": "card_id", + "description": "card_id parameter", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" }, - "descriptionHTML": "

team_slug parameter

" + "descriptionHTML": "

card_id parameter

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions \\\n -d '{\"title\":\"title\",\"body\":\"body\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions \\\n  -d '{\"title\":\"title\",\"body\":\"body\"}'
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42/moves \\\n -d '{\"position\":\"position\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42/moves \\\n  -d '{\"position\":\"position\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /orgs/{org}/teams/{team_slug}/discussions', {\n org: 'org',\n team_slug: 'team_slug',\n title: 'title',\n body: 'body'\n})", - "html": "
await octokit.request('POST /orgs/{org}/teams/{team_slug}/discussions', {\n  org: 'org',\n  team_slug: 'team_slug',\n  title: 'title',\n  body: 'body'\n})\n
" + "source": "await octokit.request('POST /projects/columns/cards/{card_id}/moves', {\n card_id: 42,\n position: 'position',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('POST /projects/columns/cards/{card_id}/moves', {\n  card_id: 42,\n  position: 'position',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" } ], - "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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 abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", + "summary": "Move a project card", + "description": "", "tags": [ - "teams" + "projects" ], - "operationId": "teams/create-discussion-in-org", + "operationId": "projects/move-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-discussion" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#move-a-project-card" }, "requestBody": { "content": { "application/json": { "schema": { - "type": "object", "properties": { - "title": { - "type": "string", - "description": "

Required. The discussion post's title.

", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "childParamsGroups": [] - }, - "body": { + "position": { + "description": "

Required. The position of the card in a column

", + "example": "bottom", "type": "string", - "description": "

Required. The discussion post's body text.

", - "name": "body", + "pattern": "^(?:top|bottom|after:\\d+)$", + "name": "position", "in": "body", "rawType": "string", - "rawDescription": "The discussion post's body text.", + "rawDescription": "The position of the card in a column", "childParamsGroups": [] }, - "private": { - "type": "boolean", - "description": "

Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

", - "default": false, - "name": "private", + "column_id": { + "description": "

The unique identifier of the column the card should be moved to

", + "example": 42, + "type": "integer", + "name": "column_id", "in": "body", - "rawType": "boolean", - "rawDescription": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", + "rawType": "integer", + "rawDescription": "The unique identifier of the column the card should be moved to", "childParamsGroups": [] } }, "required": [ - "title", - "body" - ] - }, - "example": { - "title": "Our first team post", - "body": "Hi! This is an area for us to collaborate as a team." + "position" + ], + "type": "object" } } } }, "x-github": { - "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ { - "required": false, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", - "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" } ], - "category": "teams", - "subcategory": "discussions" + "category": "projects", + "subcategory": "cards" }, - "slug": "create-a-discussion", - "category": "teams", - "categoryLabel": "Teams", - "subcategory": "discussions", - "subcategoryLabel": "Discussions", + "slug": "move-a-project-card", + "category": "projects", + "categoryLabel": "Projects", + "subcategory": "cards", + "subcategoryLabel": "Cards", "notes": [], - "descriptionHTML": "

Creates a new discussion post on a team's page. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions.

", - "bodyParameters": [ + "responses": [ { - "type": "string", - "description": "

Required. The discussion post's title.

", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "childParamsGroups": [] + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" }, { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ], + "descriptionHTML": "", + "bodyParameters": [ + { + "description": "

Required. The position of the card in a column

", + "example": "bottom", "type": "string", - "description": "

Required. The discussion post's body text.

", - "name": "body", + "pattern": "^(?:top|bottom|after:\\d+)$", + "name": "position", "in": "body", "rawType": "string", - "rawDescription": "The discussion post's body text.", + "rawDescription": "The position of the card in a column", "childParamsGroups": [] }, { - "type": "boolean", - "description": "

Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to true to create a private post.

", - "default": false, - "name": "private", + "description": "

The unique identifier of the column the card should be moved to

", + "example": 42, + "type": "integer", + "name": "column_id", "in": "body", - "rawType": "boolean", - "rawDescription": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", + "rawType": "integer", + "rawDescription": "The unique identifier of the column the card should be moved to", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Default response", - "payload": "
{\n  \"author\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"body\": \"Hi! This is an area for us to collaborate as a team.\",\n  \"body_html\": \"<p>Hi! This is an area for us to collaborate as a team</p>\",\n  \"body_version\": \"0d495416a700fb06133c612575d92bfb\",\n  \"comments_count\": 0,\n  \"comments_url\": \"https://api.github.com/teams/2343027/discussions/1/comments\",\n  \"created_at\": \"2018-01-25T18:56:31Z\",\n  \"last_edited_at\": null,\n  \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1\",\n  \"node_id\": \"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\n  \"number\": 1,\n  \"pinned\": false,\n  \"private\": false,\n  \"team_url\": \"https://api.github.com/teams/2343027\",\n  \"title\": \"Our first team post\",\n  \"updated_at\": \"2018-01-25T18:56:31Z\",\n  \"url\": \"https://api.github.com/teams/2343027/discussions/1\",\n  \"reactions\": {\n    \"url\": \"https://api.github.com/teams/2343027/discussions/1/reactions\",\n    \"total_count\": 5,\n    \"+1\": 3,\n    \"-1\": 1,\n    \"laugh\": 0,\n    \"confused\": 0,\n    \"heart\": 1,\n    \"hooray\": 0,\n    \"eyes\": 1,\n    \"rocket\": 1\n  }\n}\n
" - } ] }, { "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", + "requestPath": "/projects/columns/{column_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

team_slug parameter

" - }, - { - "name": "discussion_number", + "name": "column_id", + "description": "column_id parameter", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "" + "descriptionHTML": "

column_id parameter

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42
" + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42\n})", - "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42\n})\n
" + "source": "await octokit.request('GET /projects/columns/{column_id}', {\n column_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('GET /projects/columns/{column_id}', {\n  column_id: 42,\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" } ], - "summary": "Get a discussion", - "description": "Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.", + "summary": "Get a project column", + "description": "", "tags": [ - "teams" + "projects" ], - "operationId": "teams/get-discussion-in-org", + "operationId": "projects/get-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#get-a-discussion" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#get-a-project-column" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ { - "required": false, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", - "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" } ], - "category": "teams", - "subcategory": "discussions" + "category": "projects", + "subcategory": "columns" }, - "slug": "get-a-discussion", - "category": "teams", - "categoryLabel": "Teams", - "subcategory": "discussions", - "subcategoryLabel": "Discussions", + "slug": "get-a-project-column", + "category": "projects", + "categoryLabel": "Projects", + "subcategory": "columns", + "subcategoryLabel": "Columns", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Get a specific discussion on a team's page. OAuth access tokens require the read:discussion scope.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.

", + "descriptionHTML": "", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"author\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"body\": \"Hi! This is an area for us to collaborate as a team.\",\n  \"body_html\": \"<p>Hi! This is an area for us to collaborate as a team</p>\",\n  \"body_version\": \"0d495416a700fb06133c612575d92bfb\",\n  \"comments_count\": 0,\n  \"comments_url\": \"https://api.github.com/teams/2343027/discussions/1/comments\",\n  \"created_at\": \"2018-01-25T18:56:31Z\",\n  \"last_edited_at\": null,\n  \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1\",\n  \"node_id\": \"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\n  \"number\": 1,\n  \"pinned\": false,\n  \"private\": false,\n  \"team_url\": \"https://api.github.com/teams/2343027\",\n  \"title\": \"Our first team post\",\n  \"updated_at\": \"2018-01-25T18:56:31Z\",\n  \"url\": \"https://api.github.com/teams/2343027/discussions/1\",\n  \"reactions\": {\n    \"url\": \"https://api.github.com/teams/2343027/discussions/1/reactions\",\n    \"total_count\": 5,\n    \"+1\": 3,\n    \"-1\": 1,\n    \"laugh\": 0,\n    \"confused\": 0,\n    \"heart\": 1,\n    \"hooray\": 0,\n    \"eyes\": 1,\n    \"rocket\": 1\n  }\n}\n
" + "payload": "
{\n  \"url\": \"https://api.github.com/projects/columns/367\",\n  \"project_url\": \"https://api.github.com/projects/120\",\n  \"cards_url\": \"https://api.github.com/projects/columns/367/cards\",\n  \"id\": 367,\n  \"node_id\": \"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\n  \"name\": \"To Do\",\n  \"created_at\": \"2016-09-05T14:18:44Z\",\n  \"updated_at\": \"2016-09-05T14:22:28Z\"\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" } ] }, { "verb": "patch", - "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", + "requestPath": "/projects/columns/{column_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

team_slug parameter

" - }, - { - "name": "discussion_number", + "name": "column_id", + "description": "column_id parameter", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "" + "descriptionHTML": "

column_id parameter

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42 \\\n -d '{\"title\":\"title\"}'", - "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42 \\\n  -d '{\"title\":\"title\"}'
" + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42 \\\n  -d '{\"name\":\"name\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n title: 'title'\n})", - "html": "
await octokit.request('PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  title: 'title'\n})\n
" + "source": "await octokit.request('PATCH /projects/columns/{column_id}', {\n column_id: 42,\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('PATCH /projects/columns/{column_id}', {\n  column_id: 42,\n  name: 'name',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" } ], - "summary": "Update a discussion", - "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.", + "summary": "Update an existing project column", + "description": "", "tags": [ - "teams" + "projects" ], - "operationId": "teams/update-discussion-in-org", + "operationId": "projects/update-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#update-a-discussion" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#update-a-project-column" }, "requestBody": { "content": { "application/json": { "schema": { - "type": "object", "properties": { - "title": { - "type": "string", - "description": "

The discussion post's title.

", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "childParamsGroups": [] - }, - "body": { + "name": { + "description": "

Required. Name of the project column

", + "example": "Remaining tasks", "type": "string", - "description": "

The discussion post's body text.

", - "name": "body", + "name": "name", "in": "body", "rawType": "string", - "rawDescription": "The discussion post's body text.", + "rawDescription": "Name of the project column", "childParamsGroups": [] } - } - }, - "example": { - "title": "Welcome to our first team post" + }, + "required": [ + "name" + ], + "type": "object" } } } @@ -15735,39 +23004,31 @@ "enabledForGitHubApps": true, "previews": [ { - "required": false, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", - "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" } ], - "category": "teams", - "subcategory": "discussions" + "category": "projects", + "subcategory": "columns" }, - "slug": "update-a-discussion", - "category": "teams", - "categoryLabel": "Teams", - "subcategory": "discussions", - "subcategoryLabel": "Discussions", + "slug": "update-an-existing-project-column", + "category": "projects", + "categoryLabel": "Projects", + "subcategory": "columns", + "subcategoryLabel": "Columns", "notes": [], - "descriptionHTML": "

Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the write:discussion scope.

\n

Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.

", + "descriptionHTML": "", "bodyParameters": [ { + "description": "

Required. Name of the project column

", + "example": "Remaining tasks", "type": "string", - "description": "

The discussion post's title.

", - "name": "title", - "in": "body", - "rawType": "string", - "rawDescription": "The discussion post's title.", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

The discussion post's body text.

", - "name": "body", + "name": "name", "in": "body", "rawType": "string", - "rawDescription": "The discussion post's body text.", + "rawDescription": "Name of the project column", "childParamsGroups": [] } ], @@ -15776,136 +23037,138 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"author\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"body\": \"Hi! This is an area for us to collaborate as a team.\",\n  \"body_html\": \"<p>Hi! This is an area for us to collaborate as a team</p>\",\n  \"body_version\": \"0d495416a700fb06133c612575d92bfb\",\n  \"comments_count\": 1,\n  \"comments_url\": \"https://api.github.com/teams/2343027/discussions/1/comments\",\n  \"created_at\": \"2018-01-25T18:56:31Z\",\n  \"last_edited_at\": \"2018-01-26T18:22:20Z\",\n  \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1\",\n  \"node_id\": \"MDE0OlRlYW1EaXNjdXNzaW9uMQ==\",\n  \"number\": 1,\n  \"pinned\": false,\n  \"private\": false,\n  \"team_url\": \"https://api.github.com/teams/2343027\",\n  \"title\": \"Welcome to our first team post\",\n  \"updated_at\": \"2018-01-26T18:22:20Z\",\n  \"url\": \"https://api.github.com/teams/2343027/discussions/1\",\n  \"reactions\": {\n    \"url\": \"https://api.github.com/teams/2343027/discussions/1/reactions\",\n    \"total_count\": 5,\n    \"+1\": 3,\n    \"-1\": 1,\n    \"laugh\": 0,\n    \"confused\": 0,\n    \"heart\": 1,\n    \"hooray\": 0,\n    \"eyes\": 1,\n    \"rocket\": 1\n  }\n}\n
" + "payload": "
{\n  \"url\": \"https://api.github.com/projects/columns/367\",\n  \"project_url\": \"https://api.github.com/projects/120\",\n  \"cards_url\": \"https://api.github.com/projects/columns/367/cards\",\n  \"id\": 367,\n  \"node_id\": \"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\n  \"name\": \"To Do\",\n  \"created_at\": \"2016-09-05T14:18:44Z\",\n  \"updated_at\": \"2016-09-05T14:22:28Z\"\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" } ] }, { "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}", + "requestPath": "/projects/columns/{column_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

team_slug parameter

" - }, - { - "name": "discussion_number", + "name": "column_id", + "description": "column_id parameter", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "" + "descriptionHTML": "

column_id parameter

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42\n})", - "html": "
await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42\n})\n
" + "source": "await octokit.request('DELETE /projects/columns/{column_id}', {\n column_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('DELETE /projects/columns/{column_id}', {\n  column_id: 42,\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" } ], - "summary": "Delete a discussion", - "description": "Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.", + "summary": "Delete a project column", + "description": "", "tags": [ - "teams" + "projects" ], - "operationId": "teams/delete-discussion-in-org", + "operationId": "projects/delete-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#delete-a-discussion" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#delete-a-project-column" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], - "category": "teams", - "subcategory": "discussions" + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" + } + ], + "category": "projects", + "subcategory": "columns" }, - "slug": "delete-a-discussion", - "category": "teams", - "categoryLabel": "Teams", - "subcategory": "discussions", - "subcategoryLabel": "Discussions", + "slug": "delete-a-project-column", + "category": "projects", + "categoryLabel": "Projects", + "subcategory": "columns", + "subcategoryLabel": "Columns", "notes": [], "responses": [ { "httpStatusCode": "204", "httpStatusMessage": "No Content", "description": "Default Response" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" } ], "bodyParameters": [], - "descriptionHTML": "

Delete a discussion from a team's page. OAuth access tokens require the write:discussion scope.

\n

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}.

" + "descriptionHTML": "" }, { "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", + "requestPath": "/projects/columns/{column_id}/cards", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

team_slug parameter

" - }, - { - "name": "discussion_number", + "name": "column_id", + "description": "column_id parameter", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "" + "descriptionHTML": "

column_id parameter

" }, { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", + "name": "archived_state", + "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "asc", - "desc" + "all", + "archived", + "not_archived" ], - "default": "desc" + "default": "not_archived" }, - "descriptionHTML": "

One of asc (ascending) or desc (descending).

" + "descriptionHTML": "

Filters the project cards that are returned by the card's state. Can be one of all,archived, or not_archived.

" }, { "name": "per_page", @@ -15931,215 +23194,340 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments
" + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/cards
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42\n})", - "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42\n})\n
" + "source": "await octokit.request('GET /projects/columns/{column_id}/cards', {\n column_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('GET /projects/columns/{column_id}/cards', {\n  column_id: 42,\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" } ], - "summary": "List discussion comments", - "description": "List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", + "summary": "List project cards", + "description": "", "tags": [ - "teams" + "projects" ], - "operationId": "teams/list-discussion-comments-in-org", + "operationId": "projects/list-cards", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#list-discussion-comments" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#list-project-cards" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ { - "required": false, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", - "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" } ], - "category": "teams", - "subcategory": "discussion-comments" + "category": "projects", + "subcategory": "cards" }, - "slug": "list-discussion-comments", - "category": "teams", - "categoryLabel": "Teams", - "subcategory": "discussion-comments", - "subcategoryLabel": "Discussion comments", + "slug": "list-project-cards", + "category": "projects", + "categoryLabel": "Projects", + "subcategory": "cards", + "subcategoryLabel": "Cards", "notes": [], "bodyParameters": [], - "descriptionHTML": "

List all comments on a team discussion. OAuth access tokens require the read:discussion scope.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.

", + "descriptionHTML": "", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"author\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"body\": \"Do you like apples?\",\n    \"body_html\": \"<p>Do you like apples?</p>\",\n    \"body_version\": \"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\n    \"created_at\": \"2018-01-15T23:53:58Z\",\n    \"last_edited_at\": null,\n    \"discussion_url\": \"https://api.github.com/teams/2403582/discussions/1\",\n    \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\n    \"node_id\": \"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\n    \"number\": 1,\n    \"updated_at\": \"2018-01-15T23:53:58Z\",\n    \"url\": \"https://api.github.com/teams/2403582/discussions/1/comments/1\",\n    \"reactions\": {\n      \"url\": \"https://api.github.com/teams/2403582/discussions/1/reactions\",\n      \"total_count\": 5,\n      \"+1\": 3,\n      \"-1\": 1,\n      \"laugh\": 0,\n      \"confused\": 0,\n      \"heart\": 1,\n      \"hooray\": 0,\n      \"eyes\": 1,\n      \"rocket\": 1\n    }\n  }\n]\n
" + "payload": "
[\n  {\n    \"url\": \"https://api.github.com/projects/columns/cards/1478\",\n    \"id\": 1478,\n    \"node_id\": \"MDExOlByb2plY3RDYXJkMTQ3OA==\",\n    \"note\": \"Add payload for delete Project column\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"created_at\": \"2016-09-05T14:21:06Z\",\n    \"updated_at\": \"2016-09-05T14:20:22Z\",\n    \"archived\": false,\n    \"column_url\": \"https://api.github.com/projects/columns/367\",\n    \"content_url\": \"https://api.github.com/repos/api-playground/projects-test/issues/3\",\n    \"project_url\": \"https://api.github.com/projects/120\"\n  }\n]\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" } ] }, { "verb": "post", - "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments", + "requestPath": "/projects/columns/{column_id}/cards", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", + "name": "column_id", + "description": "column_id parameter", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" }, - "descriptionHTML": "" + "descriptionHTML": "

column_id parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards \\\n -d '{\"note\":\"note\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/cards \\\n  -d '{\"note\":\"note\"}'
" }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

team_slug parameter

" + "lang": "JavaScript", + "source": "await octokit.request('POST /projects/columns/{column_id}/cards', {\n column_id: 42,\n note: 'note',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('POST /projects/columns/{column_id}/cards', {\n  column_id: 42,\n  note: 'note',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + } + ], + "summary": "Create a project card", + "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests)\" endpoint.", + "tags": [ + "projects" + ], + "operationId": "projects/create-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#create-a-project-card" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "oneOf": [ + { + "type": "object", + "properties": { + "note": { + "description": "The project card's note", + "example": "Update all gems", + "type": "string", + "nullable": true + } + }, + "required": [ + "note" + ] + }, + { + "type": "object", + "properties": { + "content_id": { + "description": "The unique identifier of the content associated with the card", + "example": 42, + "type": "integer" + }, + "content_type": { + "description": "The piece of content associated with the card", + "example": "PullRequest", + "type": "string" + } + }, + "required": [ + "content_id", + "content_type" + ] + } + ] + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" + } + ], + "category": "projects", + "subcategory": "cards" + }, + "slug": "create-a-project-card", + "category": "projects", + "categoryLabel": "Projects", + "subcategory": "cards", + "subcategoryLabel": "Cards", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

\n

Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Default response", + "payload": "
{\n  \"url\": \"https://api.github.com/projects/columns/cards/1478\",\n  \"id\": 1478,\n  \"node_id\": \"MDExOlByb2plY3RDYXJkMTQ3OA==\",\n  \"note\": \"Add payload for delete Project column\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2016-09-05T14:21:06Z\",\n  \"updated_at\": \"2016-09-05T14:20:22Z\",\n  \"archived\": false,\n  \"column_url\": \"https://api.github.com/projects/columns/367\",\n  \"content_url\": \"https://api.github.com/repos/api-playground/projects-test/issues/3\",\n  \"project_url\": \"https://api.github.com/projects/120\"\n}\n
" }, { - "name": "discussion_number", + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ] + }, + { + "verb": "post", + "requestPath": "/projects/columns/{column_id}/moves", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "column_id", + "description": "column_id parameter", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "" + "descriptionHTML": "

column_id parameter

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments \\\n -d '{\"body\":\"body\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments \\\n  -d '{\"body\":\"body\"}'
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/moves \\\n -d '{\"position\":\"position\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/moves \\\n  -d '{\"position\":\"position\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n body: 'body'\n})", - "html": "
await octokit.request('POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  body: 'body'\n})\n
" + "source": "await octokit.request('POST /projects/columns/{column_id}/moves', {\n column_id: 42,\n position: 'position',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('POST /projects/columns/{column_id}/moves', {\n  column_id: 42,\n  position: 'position',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" } ], - "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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 abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", + "summary": "Move a project column", + "description": "", "tags": [ - "teams" + "projects" ], - "operationId": "teams/create-discussion-comment-in-org", + "operationId": "projects/move-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-discussion-comment" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#move-a-project-column" }, "requestBody": { "content": { "application/json": { "schema": { - "type": "object", "properties": { - "body": { + "position": { + "description": "

Required. The position of the column in a project

", + "example": "last", "type": "string", - "description": "

Required. The discussion comment's body text.

", - "name": "body", + "pattern": "^(?:first|last|after:\\d+)$", + "name": "position", "in": "body", "rawType": "string", - "rawDescription": "The discussion comment's body text.", + "rawDescription": "The position of the column in a project", "childParamsGroups": [] } }, "required": [ - "body" - ] - }, - "example": { - "body": "Do you like apples?" + "position" + ], + "type": "object" } } } }, "x-github": { - "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ { - "required": false, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", - "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" } ], - "category": "teams", - "subcategory": "discussion-comments" + "category": "projects", + "subcategory": "columns" }, - "slug": "create-a-discussion-comment", - "category": "teams", - "categoryLabel": "Teams", - "subcategory": "discussion-comments", - "subcategoryLabel": "Discussion comments", + "slug": "move-a-project-column", + "category": "projects", + "categoryLabel": "Projects", + "subcategory": "columns", + "subcategoryLabel": "Columns", "notes": [], - "descriptionHTML": "

Creates a new comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

This endpoint triggers notifications. Creating content too quickly using this endpoint may result in abuse rate limiting. See \"Abuse rate limits\" and \"Dealing with abuse rate limits\" for details.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments.

", + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ], + "descriptionHTML": "", "bodyParameters": [ { + "description": "

Required. The position of the column in a project

", + "example": "last", "type": "string", - "description": "

Required. The discussion comment's body text.

", - "name": "body", + "pattern": "^(?:first|last|after:\\d+)$", + "name": "position", "in": "body", "rawType": "string", - "rawDescription": "The discussion comment's body text.", + "rawDescription": "The position of the column in a project", "childParamsGroups": [] } - ], - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Default response", - "payload": "
{\n  \"author\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"body\": \"Do you like apples?\",\n  \"body_html\": \"<p>Do you like apples?</p>\",\n  \"body_version\": \"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\n  \"created_at\": \"2018-01-15T23:53:58Z\",\n  \"last_edited_at\": null,\n  \"discussion_url\": \"https://api.github.com/teams/2403582/discussions/1\",\n  \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\n  \"node_id\": \"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\n  \"number\": 1,\n  \"updated_at\": \"2018-01-15T23:53:58Z\",\n  \"url\": \"https://api.github.com/teams/2403582/discussions/1/comments/1\",\n  \"reactions\": {\n    \"url\": \"https://api.github.com/teams/2403582/discussions/1/reactions\",\n    \"total_count\": 5,\n    \"+1\": 3,\n    \"-1\": 1,\n    \"laugh\": 0,\n    \"confused\": 0,\n    \"heart\": 1,\n    \"hooray\": 0,\n    \"eyes\": 1,\n    \"rocket\": 1\n  }\n}\n
" - } ] }, { "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", + "requestPath": "/projects/{project_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

team_slug parameter

" - }, - { - "name": "discussion_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "" - }, - { - "name": "comment_number", + "name": "project_id", "in": "path", "required": true, "schema": { @@ -16151,91 +23539,76 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42
" + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n comment_number: 42\n})", - "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  comment_number: 42\n})\n
" + "source": "await octokit.request('GET /projects/{project_id}', {\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('GET /projects/{project_id}', {\n  project_id: 42,\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" } ], - "summary": "Get a discussion comment", - "description": "Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.", + "summary": "Get a project", + "description": "Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", "tags": [ - "teams" + "projects" ], - "operationId": "teams/get-discussion-comment-in-org", + "operationId": "projects/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#get-a-discussion-comment" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects/#get-a-project" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ { - "required": false, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", - "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" } ], - "category": "teams", - "subcategory": "discussion-comments" + "category": "projects", + "subcategory": null }, - "slug": "get-a-discussion-comment", - "category": "teams", - "categoryLabel": "Teams", - "subcategory": "discussion-comments", - "subcategoryLabel": "Discussion comments", + "slug": "get-a-project", + "category": "projects", + "categoryLabel": "Projects", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Get a specific comment on a team discussion. OAuth access tokens require the read:discussion scope.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.

", + "descriptionHTML": "

Gets a project by its id. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"author\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"body\": \"Do you like apples?\",\n  \"body_html\": \"<p>Do you like apples?</p>\",\n  \"body_version\": \"5eb32b219cdc6a5a9b29ba5d6caa9c51\",\n  \"created_at\": \"2018-01-15T23:53:58Z\",\n  \"last_edited_at\": null,\n  \"discussion_url\": \"https://api.github.com/teams/2403582/discussions/1\",\n  \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\n  \"node_id\": \"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\n  \"number\": 1,\n  \"updated_at\": \"2018-01-15T23:53:58Z\",\n  \"url\": \"https://api.github.com/teams/2403582/discussions/1/comments/1\",\n  \"reactions\": {\n    \"url\": \"https://api.github.com/teams/2403582/discussions/1/reactions\",\n    \"total_count\": 5,\n    \"+1\": 3,\n    \"-1\": 1,\n    \"laugh\": 0,\n    \"confused\": 0,\n    \"heart\": 1,\n    \"hooray\": 0,\n    \"eyes\": 1,\n    \"rocket\": 1\n  }\n}\n
" + "payload": "
{\n  \"owner_url\": \"https://api.github.com/repos/api-playground/projects-test\",\n  \"url\": \"https://api.github.com/projects/1002604\",\n  \"html_url\": \"https://github.com/api-playground/projects-test/projects/1\",\n  \"columns_url\": \"https://api.github.com/projects/1002604/columns\",\n  \"id\": 1002604,\n  \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDQ=\",\n  \"name\": \"Projects Documentation\",\n  \"body\": \"Developer documentation project for the developer site.\",\n  \"number\": 1,\n  \"state\": \"open\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2011-04-10T20:09:31Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\"\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" } ] }, { "verb": "patch", - "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", + "requestPath": "/projects/{project_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

team_slug parameter

" - }, - { - "name": "discussion_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "" - }, - { - "name": "comment_number", + "name": "project_id", "in": "path", "required": true, "schema": { @@ -16247,47 +23620,87 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42 \\\n -d '{\"body\":\"body\"}'", - "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42 \\\n  -d '{\"body\":\"body\"}'
" + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42 \\\n -d '{\"name\":\"name\"}'", + "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42 \\\n  -d '{\"name\":\"name\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n comment_number: 42,\n body: 'body'\n})", - "html": "
await octokit.request('PATCH /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  comment_number: 42,\n  body: 'body'\n})\n
" + "source": "await octokit.request('PATCH /projects/{project_id}', {\n project_id: 42,\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('PATCH /projects/{project_id}', {\n  project_id: 42,\n  name: 'name',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" } ], - "summary": "Update a discussion comment", - "description": "Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.", + "summary": "Update a project", + "description": "Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "operationId": "projects/update", "tags": [ - "teams" + "projects" ], - "operationId": "teams/update-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#update-a-discussion-comment" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects/#update-a-project" }, "requestBody": { "content": { "application/json": { "schema": { - "type": "object", "properties": { - "body": { + "name": { + "description": "

Name of the project

", + "example": "Week One Sprint", "type": "string", - "description": "

Required. The discussion comment's body text.

", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "Name of the project", + "childParamsGroups": [] + }, + "body": { + "description": "

Body of the project

", + "example": "This project represents the sprint of the first week in January", + "type": "string or null", + "nullable": true, "name": "body", "in": "body", "rawType": "string", - "rawDescription": "The discussion comment's body text.", + "rawDescription": "Body of the project", + "childParamsGroups": [] + }, + "state": { + "description": "

State of the project; either 'open' or 'closed'

", + "example": "open", + "type": "string", + "name": "state", + "in": "body", + "rawType": "string", + "rawDescription": "State of the project; either 'open' or 'closed'", + "childParamsGroups": [] + }, + "organization_permission": { + "description": "

The baseline permission that all organization members have on this project

", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ], + "name": "organization_permission", + "in": "body", + "rawType": "string", + "rawDescription": "The baseline permission that all organization members have on this project", + "childParamsGroups": [] + }, + "private": { + "description": "

Whether or not this project can be seen by everyone.

", + "type": "boolean", + "name": "private", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether or not this project can be seen by everyone.", "childParamsGroups": [] } }, - "required": [ - "body" - ] - }, - "example": { - "body": "Do you like pineapples?" + "type": "object" } } } @@ -16297,30 +23710,74 @@ "enabledForGitHubApps": true, "previews": [ { - "required": false, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", - "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" } ], - "category": "teams", - "subcategory": "discussion-comments" + "category": "projects", + "subcategory": null }, - "slug": "update-a-discussion-comment", - "category": "teams", - "categoryLabel": "Teams", - "subcategory": "discussion-comments", - "subcategoryLabel": "Discussion comments", + "slug": "update-a-project", + "category": "projects", + "categoryLabel": "Projects", "notes": [], - "descriptionHTML": "

Edits the body text of a discussion comment. OAuth access tokens require the write:discussion scope.

\n

Note: You can also specify a team by org_id and team_id using the route PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.

", + "descriptionHTML": "

Updates a project board's information. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

", "bodyParameters": [ { + "description": "

Name of the project

", + "example": "Week One Sprint", "type": "string", - "description": "

Required. The discussion comment's body text.

", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "Name of the project", + "childParamsGroups": [] + }, + { + "description": "

Body of the project

", + "example": "This project represents the sprint of the first week in January", + "type": "string or null", + "nullable": true, "name": "body", "in": "body", "rawType": "string", - "rawDescription": "The discussion comment's body text.", + "rawDescription": "Body of the project", + "childParamsGroups": [] + }, + { + "description": "

State of the project; either 'open' or 'closed'

", + "example": "open", + "type": "string", + "name": "state", + "in": "body", + "rawType": "string", + "rawDescription": "State of the project; either 'open' or 'closed'", + "childParamsGroups": [] + }, + { + "description": "

The baseline permission that all organization members have on this project

", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ], + "name": "organization_permission", + "in": "body", + "rawType": "string", + "rawDescription": "The baseline permission that all organization members have on this project", + "childParamsGroups": [] + }, + { + "description": "

Whether or not this project can be seen by everyone.

", + "type": "boolean", + "name": "private", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether or not this project can be seen by everyone.", "childParamsGroups": [] } ], @@ -16329,45 +23786,47 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"author\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"body\": \"Do you like pineapples?\",\n  \"body_html\": \"<p>Do you like pineapples?</p>\",\n  \"body_version\": \"e6907b24d9c93cc0c5024a7af5888116\",\n  \"created_at\": \"2018-01-15T23:53:58Z\",\n  \"last_edited_at\": \"2018-01-26T18:22:20Z\",\n  \"discussion_url\": \"https://api.github.com/teams/2403582/discussions/1\",\n  \"html_url\": \"https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1\",\n  \"node_id\": \"MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=\",\n  \"number\": 1,\n  \"updated_at\": \"2018-01-26T18:22:20Z\",\n  \"url\": \"https://api.github.com/teams/2403582/discussions/1/comments/1\",\n  \"reactions\": {\n    \"url\": \"https://api.github.com/teams/2403582/discussions/1/reactions\",\n    \"total_count\": 5,\n    \"+1\": 3,\n    \"-1\": 1,\n    \"laugh\": 0,\n    \"confused\": 0,\n    \"heart\": 1,\n    \"hooray\": 0,\n    \"eyes\": 1,\n    \"rocket\": 1\n  }\n}\n
" + "payload": "
{\n  \"owner_url\": \"https://api.github.com/repos/api-playground/projects-test\",\n  \"url\": \"https://api.github.com/projects/1002604\",\n  \"html_url\": \"https://github.com/api-playground/projects-test/projects/1\",\n  \"columns_url\": \"https://api.github.com/projects/1002604/columns\",\n  \"id\": 1002604,\n  \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDQ=\",\n  \"name\": \"Projects Documentation\",\n  \"body\": \"Developer documentation project for the developer site.\",\n  \"number\": 1,\n  \"state\": \"open\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2011-04-10T20:09:31Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\"\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Response if the authenticated user does not have access to the project" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" } ] }, { "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}", + "requestPath": "/projects/{project_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

team_slug parameter

" - }, - { - "name": "discussion_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "" - }, - { - "name": "comment_number", + "name": "project_id", "in": "path", "required": true, "schema": { @@ -16379,83 +23838,85 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n comment_number: 42\n})", - "html": "
await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  comment_number: 42\n})\n
" + "source": "await octokit.request('DELETE /projects/{project_id}', {\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('DELETE /projects/{project_id}', {\n  project_id: 42,\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" } ], - "summary": "Delete a discussion comment", - "description": "Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.", + "summary": "Delete a project", + "description": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled.", + "operationId": "projects/delete", "tags": [ - "teams" + "projects" ], - "operationId": "teams/delete-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#delete-a-discussion-comment" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects/#delete-a-project" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], - "category": "teams", - "subcategory": "discussion-comments" + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" + } + ], + "category": "projects", + "subcategory": null }, - "slug": "delete-a-discussion-comment", - "category": "teams", - "categoryLabel": "Teams", - "subcategory": "discussion-comments", - "subcategoryLabel": "Discussion comments", + "slug": "delete-a-project", + "category": "projects", + "categoryLabel": "Projects", "notes": [], "responses": [ { "httpStatusCode": "204", "httpStatusMessage": "No Content", - "description": "Default Response" + "description": "Delete success" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" } ], "bodyParameters": [], - "descriptionHTML": "

Deletes a comment on a team discussion. OAuth access tokens require the write:discussion scope.

\n

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}.

" + "descriptionHTML": "

Deletes a project board. Returns a 404 Not Found status if projects are disabled.

" }, { "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", + "requestPath": "/projects/{project_id}/collaborators", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

team_slug parameter

" - }, - { - "name": "discussion_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "" - }, - { - "name": "comment_number", + "name": "project_id", "in": "path", "required": true, "schema": { @@ -16464,24 +23925,20 @@ "descriptionHTML": "" }, { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", + "name": "affiliation", + "description": "Filters the collaborators by their affiliation. Can be one of: \n\\* `outside`: Outside collaborators of a project that are not a member of the project's organization. \n\\* `direct`: Collaborators with permissions to a project, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "outside", + "direct", + "all" + ], + "default": "all" }, - "descriptionHTML": "

Returns a single reaction type. Omit this parameter to list all reactions to a team discussion comment.

" + "descriptionHTML": "

Filters the collaborators by their affiliation. Can be one of:
\n* outside: Outside collaborators of a project that are not a member of the project's organization.
\n* direct: Collaborators with permissions to a project, regardless of organization membership status.
\n* all: All collaborators the authenticated user can see.

" }, { "name": "per_page", @@ -16507,24 +23964,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions
" + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n comment_number: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})", - "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  comment_number: 42,\n  mediaType: {\n    previews: [\n      'squirrel-girl'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /projects/{project_id}/collaborators', {\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('GET /projects/{project_id}/collaborators', {\n  project_id: 42,\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" } ], - "summary": "List reactions for a team discussion comment", - "description": "List the reactions to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.", + "summary": "List project collaborators", + "description": "Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators.", "tags": [ - "reactions" + "projects" ], - "operationId": "reactions/list-for-team-discussion-comment-in-org", + "operationId": "projects/list-collaborators", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#list-reactions-for-a-team-discussion-comment" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#list-project-collaborators" }, "x-github": { "githubCloudOnly": false, @@ -16532,55 +23989,68 @@ "previews": [ { "required": true, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", - "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" } ], - "category": "reactions", - "subcategory": null + "category": "projects", + "subcategory": "collaborators" }, - "slug": "list-reactions-for-a-team-discussion-comment", - "category": "reactions", - "categoryLabel": "Reactions", + "slug": "list-project-collaborators", + "category": "projects", + "categoryLabel": "Projects", + "subcategory": "collaborators", + "subcategoryLabel": "Collaborators", "notes": [], "bodyParameters": [], - "descriptionHTML": "

List the reactions to a team discussion comment. OAuth access tokens require the read:discussion scope.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.

", + "descriptionHTML": "

Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDg6UmVhY3Rpb24x\",\n    \"user\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"content\": \"heart\",\n    \"created_at\": \"2016-05-20T20:09:31Z\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n]\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" } ] }, { - "verb": "post", - "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions", + "verb": "put", + "requestPath": "/projects/{project_id}/collaborators/{username}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

team_slug parameter

" - }, - { - "name": "discussion_number", + "name": "project_id", "in": "path", "required": true, "schema": { @@ -16589,11 +24059,11 @@ "descriptionHTML": "" }, { - "name": "comment_number", + "name": "username", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" }, "descriptionHTML": "" } @@ -16601,24 +24071,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions \\\n  -d '{\"content\":\"content\"}'
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n comment_number: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})", - "html": "
await octokit.request('POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  comment_number: 42,\n  content: 'content',\n  mediaType: {\n    previews: [\n      'squirrel-girl'\n    ]\n  }\n})\n
" + "source": "await octokit.request('PUT /projects/{project_id}/collaborators/{username}', {\n project_id: 42,\n username: 'username',\n permission: 'permission',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('PUT /projects/{project_id}/collaborators/{username}', {\n  project_id: 42,\n  username: 'username',\n  permission: 'permission',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" } ], - "summary": "Create reaction for a team discussion comment", - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.", + "summary": "Add project collaborator", + "description": "Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.", "tags": [ - "reactions" + "projects" ], - "operationId": "reactions/create-for-team-discussion-comment-in-org", + "operationId": "projects/add-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#create-reaction-for-a-team-discussion-comment" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#add-project-collaborator" }, "requestBody": { "content": { @@ -16626,32 +24096,23 @@ "schema": { "type": "object", "properties": { - "content": { - "type": "string", - "description": "

Required. The reaction type to add to the team discussion comment.

", + "permission": { + "description": "

The permission to grant the collaborator.

", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" + "read", + "write", + "admin" ], - "name": "content", + "default": "write", + "example": "write", + "type": "string", + "name": "permission", "in": "body", "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types) to add to the team discussion comment.", + "rawDescription": "The permission to grant the collaborator.", "childParamsGroups": [] } - }, - "required": [ - "content" - ] - }, - "example": { - "content": "heart" + } } } } @@ -16662,84 +24123,84 @@ "previews": [ { "required": true, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", - "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" } ], - "category": "reactions", - "subcategory": null + "category": "projects", + "subcategory": "collaborators" }, - "slug": "create-reaction-for-a-team-discussion-comment", - "category": "reactions", - "categoryLabel": "Reactions", + "slug": "add-project-collaborator", + "category": "projects", + "categoryLabel": "Projects", + "subcategory": "collaborators", + "subcategoryLabel": "Collaborators", "notes": [], - "descriptionHTML": "

Create a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion comment.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions.

", - "bodyParameters": [ - { - "type": "string", - "description": "

Required. The reaction type to add to the team discussion comment.

", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", - "in": "body", - "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types) to add to the team discussion comment.", - "childParamsGroups": [] - } - ], "responses": [ { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Default response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDg6UmVhY3Rpb24x\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"content\": \"heart\",\n  \"created_at\": \"2016-05-20T20:09:31Z\"\n}\n
" - } - ] - }, - { - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}", - "serverUrl": "https://api.github.com", - "parameters": [ + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + }, { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

team_slug parameter

" + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" }, { - "name": "discussion_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "" + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" }, { - "name": "comment_number", + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ], + "descriptionHTML": "

Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project admin to add a collaborator.

", + "bodyParameters": [ + { + "description": "

The permission to grant the collaborator.

", + "enum": [ + "read", + "write", + "admin" + ], + "default": "write", + "example": "write", + "type": "string", + "name": "permission", + "in": "body", + "rawType": "string", + "rawDescription": "The permission to grant the collaborator.", + "childParamsGroups": [] + } + ] + }, + { + "verb": "delete", + "requestPath": "/projects/{project_id}/collaborators/{username}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "project_id", "in": "path", "required": true, "schema": { @@ -16748,11 +24209,11 @@ "descriptionHTML": "" }, { - "name": "reaction_id", + "name": "username", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" }, "descriptionHTML": "" } @@ -16760,24 +24221,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions/42", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/comments/42/reactions/42
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n comment_number: 42,\n reaction_id: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})", - "html": "
await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  comment_number: 42,\n  reaction_id: 42,\n  mediaType: {\n    previews: [\n      'squirrel-girl'\n    ]\n  }\n})\n
" + "source": "await octokit.request('DELETE /projects/{project_id}/collaborators/{username}', {\n project_id: 42,\n username: 'username',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('DELETE /projects/{project_id}/collaborators/{username}', {\n  project_id: 42,\n  username: 'username',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" } ], - "summary": "Delete team discussion comment reaction", - "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "summary": "Remove user as a collaborator", + "description": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.", "tags": [ - "reactions" + "projects" ], - "operationId": "reactions/delete-for-team-discussion-comment", + "operationId": "projects/remove-collaborator", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#delete-team-discussion-comment-reaction" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#remove-project-collaborator" }, "x-github": { "githubCloudOnly": false, @@ -16785,54 +24246,174 @@ "previews": [ { "required": true, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", - "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" } ], - "category": "reactions", - "subcategory": null + "category": "projects", + "subcategory": "collaborators" }, - "slug": "delete-team-discussion-comment-reaction", - "category": "reactions", - "categoryLabel": "Reactions", + "slug": "remove-user-as-a-collaborator", + "category": "projects", + "categoryLabel": "Projects", + "subcategory": "collaborators", + "subcategoryLabel": "Collaborators", "notes": [], "responses": [ { "httpStatusCode": "204", "httpStatusMessage": "No Content", "description": "Default Response" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" } ], "bodyParameters": [], - "descriptionHTML": "

Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id.

\n

Delete a reaction to a team discussion comment. OAuth access tokens require the write:discussion scope.

" + "descriptionHTML": "

Removes a collaborator from an organization project. You must be an organization owner or a project admin to remove a collaborator.

" }, { "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", + "requestPath": "/projects/{project_id}/collaborators/{username}/permission", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", + "name": "project_id", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" }, "descriptionHTML": "" }, { - "name": "team_slug", - "description": "team_slug parameter", + "name": "username", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

team_slug parameter

" + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME/permission", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME/permission
" }, { - "name": "discussion_number", + "lang": "JavaScript", + "source": "await octokit.request('GET /projects/{project_id}/collaborators/{username}/permission', {\n project_id: 42,\n username: 'username',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('GET /projects/{project_id}/collaborators/{username}/permission', {\n  project_id: 42,\n  username: 'username',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + } + ], + "summary": "Get project permission for a user", + "description": "Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.", + "tags": [ + "projects" + ], + "operationId": "projects/get-permission-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#get-project-permission-for-a-user" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" + } + ], + "category": "projects", + "subcategory": "collaborators" + }, + "slug": "get-project-permission-for-a-user", + "category": "projects", + "categoryLabel": "Projects", + "subcategory": "collaborators", + "subcategoryLabel": "Collaborators", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Returns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"permission\": \"admin\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" + } + ] + }, + { + "verb": "get", + "requestPath": "/projects/{project_id}/columns", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "project_id", "in": "path", "required": true, "schema": { @@ -16840,26 +24421,6 @@ }, "descriptionHTML": "" }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "descriptionHTML": "

Returns a single reaction type. Omit this parameter to list all reactions to a team discussion.

" - }, { "name": "per_page", "description": "Results per page (max 100).", @@ -16884,24 +24445,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions
" + "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/columns
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})", - "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  mediaType: {\n    previews: [\n      'squirrel-girl'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /projects/{project_id}/columns', {\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('GET /projects/{project_id}/columns', {\n  project_id: 42,\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" } ], - "summary": "List reactions for a team discussion", - "description": "List the reactions to a [team discussion](https://docs.github.com/github-ae@latest/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.", + "summary": "List project columns", + "description": "", "tags": [ - "reactions" + "projects" ], - "operationId": "reactions/list-for-team-discussion-in-org", + "operationId": "projects/list-columns", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#list-reactions-for-a-team-discussion" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#list-project-columns" }, "x-github": { "githubCloudOnly": false, @@ -16909,55 +24470,53 @@ "previews": [ { "required": true, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", - "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" } ], - "category": "reactions", - "subcategory": null + "category": "projects", + "subcategory": "columns" }, - "slug": "list-reactions-for-a-team-discussion", - "category": "reactions", - "categoryLabel": "Reactions", + "slug": "list-project-columns", + "category": "projects", + "categoryLabel": "Projects", + "subcategory": "columns", + "subcategoryLabel": "Columns", "notes": [], "bodyParameters": [], - "descriptionHTML": "

List the reactions to a team discussion. OAuth access tokens require the read:discussion scope.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.

", + "descriptionHTML": "", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"id\": 1,\n    \"node_id\": \"MDg6UmVhY3Rpb24x\",\n    \"user\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"content\": \"heart\",\n    \"created_at\": \"2016-05-20T20:09:31Z\"\n  }\n]\n
" + "payload": "
[\n  {\n    \"url\": \"https://api.github.com/projects/columns/367\",\n    \"project_url\": \"https://api.github.com/projects/120\",\n    \"cards_url\": \"https://api.github.com/projects/columns/367/cards\",\n    \"id\": 367,\n    \"node_id\": \"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\n    \"name\": \"To Do\",\n    \"created_at\": \"2016-09-05T14:18:44Z\",\n    \"updated_at\": \"2016-09-05T14:22:28Z\"\n  }\n]\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" } ] }, { "verb": "post", - "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions", + "requestPath": "/projects/{project_id}/columns", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

team_slug parameter

" - }, - { - "name": "discussion_number", + "name": "project_id", "in": "path", "required": true, "schema": { @@ -16969,98 +24528,79 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions \\\n -d '{\"content\":\"content\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions \\\n  -d '{\"content\":\"content\"}'
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns \\\n -d '{\"name\":\"name\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/columns \\\n  -d '{\"name\":\"name\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n content: 'content',\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})", - "html": "
await octokit.request('POST /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  content: 'content',\n  mediaType: {\n    previews: [\n      'squirrel-girl'\n    ]\n  }\n})\n
" + "source": "await octokit.request('POST /projects/{project_id}/columns', {\n project_id: 42,\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", + "html": "
await octokit.request('POST /projects/{project_id}/columns', {\n  project_id: 42,\n  name: 'name',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" } ], - "summary": "Create reaction for a team discussion", - "description": "Create a reaction to a [team discussion](https://docs.github.com/github-ae@latest/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.", + "summary": "Create a project column", + "description": "", "tags": [ - "reactions" + "projects" ], - "operationId": "reactions/create-for-team-discussion-in-org", + "operationId": "projects/create-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#create-reaction-for-a-team-discussion" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#create-a-project-column" }, "requestBody": { "content": { "application/json": { "schema": { - "type": "object", "properties": { - "content": { + "name": { + "description": "

Required. Name of the project column

", + "example": "Remaining tasks", "type": "string", - "description": "

Required. The reaction type to add to the team discussion.

", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", + "name": "name", "in": "body", "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types) to add to the team discussion.", + "rawDescription": "Name of the project column", "childParamsGroups": [] } }, "required": [ - "content" - ] - }, - "example": { - "content": "heart" + "name" + ], + "type": "object" } } } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "previews": [ { "required": true, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", - "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", + "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" } ], - "category": "reactions", - "subcategory": null + "category": "projects", + "subcategory": "columns" }, - "slug": "create-reaction-for-a-team-discussion", - "category": "reactions", - "categoryLabel": "Reactions", + "slug": "create-a-project-column", + "category": "projects", + "categoryLabel": "Projects", + "subcategory": "columns", + "subcategoryLabel": "Columns", "notes": [], - "descriptionHTML": "

Create a reaction to a team discussion. OAuth access tokens require the write:discussion scope. A response with a Status: 200 OK means that you already added the reaction type to this team discussion.

\n

Note: You can also specify a team by org_id and team_id using the route POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions.

", + "descriptionHTML": "", "bodyParameters": [ { + "description": "

Required. Name of the project column

", + "example": "Remaining tasks", "type": "string", - "description": "

Required. The reaction type to add to the team discussion.

", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ], - "name": "content", + "name": "name", "in": "body", "rawType": "string", - "rawDescription": "The [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types) to add to the team discussion.", + "rawDescription": "Name of the project column", "childParamsGroups": [] } ], @@ -17068,44 +24608,95 @@ { "httpStatusCode": "201", "httpStatusMessage": "Created", - "description": "Default response", - "payload": "
{\n  \"id\": 1,\n  \"node_id\": \"MDg6UmVhY3Rpb24x\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"content\": \"heart\",\n  \"created_at\": \"2016-05-20T20:09:31Z\"\n}\n
" + "description": "Response", + "payload": "
{\n  \"url\": \"https://api.github.com/projects/columns/367\",\n  \"project_url\": \"https://api.github.com/projects/120\",\n  \"cards_url\": \"https://api.github.com/projects/columns/367/cards\",\n  \"id\": 367,\n  \"node_id\": \"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\n  \"name\": \"To Do\",\n  \"created_at\": \"2016-09-05T14:18:44Z\",\n  \"updated_at\": \"2016-09-05T14:22:28Z\"\n}\n
" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" } ] }, { - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}", + "verb": "get", + "requestPath": "/rate_limit", "serverUrl": "https://api.github.com", - "parameters": [ + "parameters": [], + "x-codeSamples": [ { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/rate_limit", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/rate_limit
" }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

team_slug parameter

" + "lang": "JavaScript", + "source": "await octokit.request('GET /rate_limit')", + "html": "
await octokit.request('GET /rate_limit')\n
" + } + ], + "summary": "Get rate limit status for the authenticated user", + "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "tags": [ + "rate-limit" + ], + "operationId": "rate-limit/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/rate_limit/#get-rate-limit-status-for-the-authenticated-user" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "rate-limit", + "subcategory": null + }, + "slug": "get-rate-limit-status-for-the-authenticated-user", + "category": "rate-limit", + "categoryLabel": "Rate limit", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Note: Accessing this endpoint does not count against your REST API rate limit.

\n

Note: The rate object is deprecated. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"resources\": {\n    \"core\": {\n      \"limit\": 5000,\n      \"remaining\": 4999,\n      \"reset\": 1372700873\n    },\n    \"search\": {\n      \"limit\": 30,\n      \"remaining\": 18,\n      \"reset\": 1372697452\n    },\n    \"graphql\": {\n      \"limit\": 5000,\n      \"remaining\": 4993,\n      \"reset\": 1372700389\n    },\n    \"integration_manifest\": {\n      \"limit\": 5000,\n      \"remaining\": 4999,\n      \"reset\": 1551806725\n    },\n    \"code_scanning_upload\": {\n      \"limit\": 500,\n      \"remaining\": 499,\n      \"reset\": 1551806725\n    }\n  },\n  \"rate\": {\n    \"limit\": 5000,\n    \"remaining\": 4999,\n    \"reset\": 1372700873\n  }\n}\n
" }, { - "name": "discussion_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "" + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + } + ] + }, + { + "verb": "delete", + "requestPath": "/reactions/{reaction_id}", + "serverUrl": "https://api.github.com", + "parameters": [ { "name": "reaction_id", "in": "path", @@ -17119,24 +24710,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions/42", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/discussions/42/reactions/42
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/reactions/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/reactions/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}', {\n org: 'org',\n team_slug: 'team_slug',\n discussion_number: 42,\n reaction_id: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})", - "html": "
await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  discussion_number: 42,\n  reaction_id: 42,\n  mediaType: {\n    previews: [\n      'squirrel-girl'\n    ]\n  }\n})\n
" + "source": "await octokit.request('DELETE /reactions/{reaction_id}', {\n reaction_id: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})", + "html": "
await octokit.request('DELETE /reactions/{reaction_id}', {\n  reaction_id: 42,\n  mediaType: {\n    previews: [\n      'squirrel-girl'\n    ]\n  }\n})\n
" } ], - "summary": "Delete team discussion reaction", - "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/github-ae@latest/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "summary": "Delete a reaction (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/).\n\nOAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/github-ae@latest/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments).", "tags": [ "reactions" ], - "operationId": "reactions/delete-for-team-discussion", + "operationId": "reactions/delete-legacy", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#delete-team-discussion-reaction" + "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#delete-a-reaction-legacy" }, "x-github": { "githubCloudOnly": false, @@ -17149,10 +24740,13 @@ "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" } ], + "removalDate": "2021-02-21", + "deprecationDate": "2020-02-26", "category": "reactions", "subcategory": null }, - "slug": "delete-team-discussion-reaction", + "deprecated": true, + "slug": "delete-a-reaction-legacy", "category": "reactions", "categoryLabel": "Reactions", "notes": [], @@ -17161,18 +24755,43 @@ "httpStatusCode": "204", "httpStatusMessage": "No Content", "description": "Default Response" + }, + { + "httpStatusCode": "304", + "httpStatusMessage": "Not Modified", + "description": "Not modified" + }, + { + "httpStatusCode": "401", + "httpStatusMessage": "Unauthorized", + "description": "Requires authentication" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "410", + "httpStatusMessage": "Gone", + "description": "Gone" + }, + { + "httpStatusCode": "415", + "httpStatusMessage": "Unsupported Media Type", + "description": "Preview header missing" } ], "bodyParameters": [], - "descriptionHTML": "

Note: You can also specify a team or organization with team_id and org_id using the route DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id.

\n

Delete a reaction to a team discussion. OAuth access tokens require the write:discussion scope.

" + "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this blog post.

\n

OAuth access tokens require the write:discussion scope, when deleting a team discussion or team discussion comment.

" }, { "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/members", + "requestPath": "/repos/{owner}/{repo}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", + "name": "owner", "in": "path", "required": true, "schema": { @@ -17181,105 +24800,100 @@ "descriptionHTML": "" }, { - "name": "team_slug", - "description": "team_slug parameter", + "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

team_slug parameter

" - }, - { - "name": "role", - "description": "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "member", - "maintainer", - "all" - ], - "default": "all" - }, - "descriptionHTML": "

Filters members returned by their role in the team. Can be one of:
\n* member - normal members of the team.
\n* maintainer - team maintainers.
\n* all - all members of the team.

" - }, - { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - }, - "descriptionHTML": "

Results per page (max 100).

" - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - }, - "descriptionHTML": "

Page number of the results to fetch.

" + "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/members", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/members
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/members', {\n org: 'org',\n team_slug: 'team_slug'\n})", - "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/members', {\n  org: 'org',\n  team_slug: 'team_slug'\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" } ], - "summary": "List team members", - "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "summary": "Get a repository", + "description": "When you pass the `scarlet-witch-preview` media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.\n\nThe `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.", "tags": [ - "teams" + "repos" ], - "operationId": "teams/list-members-in-org", + "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#list-team-members" + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#get-a-repository" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], - "category": "teams", - "subcategory": "members" + "previews": [ + { + "required": false, + "name": "nebula", + "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```", + "html": "

You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.

\n

To access repository visibility during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.nebula-preview+json
" + }, + { + "required": false, + "name": "scarlet-witch", + "note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```", + "html": "

The Codes of Conduct API is currently available for developers to preview.

\n

To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.scarlet-witch-preview+json
" + } + ], + "category": "repos", + "subcategory": null }, - "slug": "list-team-members", - "category": "teams", - "categoryLabel": "Teams", - "subcategory": "members", - "subcategoryLabel": "Members", + "slug": "get-a-repository", + "category": "repos", + "categoryLabel": "Repos", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Team members will include the members of child teams.

\n

To list members in a team, the team must be visible to the authenticated user.

", + "descriptionHTML": "

When you pass the scarlet-witch-preview media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.

\n

The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n]\n
" + "payload": "
{\n  \"id\": 1296269,\n  \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n  \"name\": \"Hello-World\",\n  \"full_name\": \"octocat/Hello-World\",\n  \"owner\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"private\": false,\n  \"html_url\": \"https://github.com/octocat/Hello-World\",\n  \"description\": \"This your first repo!\",\n  \"fork\": false,\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n  \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n  \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n  \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n  \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n  \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n  \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n  \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n  \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n  \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n  \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n  \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n  \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n  \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n  \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n  \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n  \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n  \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n  \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n  \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n  \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n  \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n  \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n  \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n  \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n  \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n  \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n  \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n  \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n  \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n  \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n  \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n  \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n  \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n  \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n  \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n  \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n  \"homepage\": \"https://github.com\",\n  \"language\": null,\n  \"forks_count\": 9,\n  \"forks\": 9,\n  \"stargazers_count\": 80,\n  \"watchers_count\": 80,\n  \"watchers\": 80,\n  \"size\": 108,\n  \"default_branch\": \"master\",\n  \"open_issues_count\": 0,\n  \"open_issues\": 0,\n  \"is_template\": false,\n  \"topics\": [\n    \"octocat\",\n    \"atom\",\n    \"electron\",\n    \"api\"\n  ],\n  \"has_issues\": true,\n  \"has_projects\": true,\n  \"has_wiki\": true,\n  \"has_pages\": false,\n  \"has_downloads\": true,\n  \"archived\": false,\n  \"disabled\": false,\n  \"visibility\": \"public\",\n  \"pushed_at\": \"2011-01-26T19:06:43Z\",\n  \"created_at\": \"2011-01-26T19:01:12Z\",\n  \"updated_at\": \"2011-01-26T19:14:43Z\",\n  \"permissions\": {\n    \"pull\": true,\n    \"push\": false,\n    \"admin\": false\n  },\n  \"allow_rebase_merge\": true,\n  \"template_repository\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World-Template\",\n    \"full_name\": \"octocat/Hello-World-Template\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World-Template\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World-Template\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World-Template.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World-Template.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World-Template.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World-Template\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World-Template\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks\": 9,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"watchers\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues\": 0,\n    \"open_issues_count\": 0,\n    \"is_template\": true,\n    \"license\": {\n      \"key\": \"mit\",\n      \"name\": \"MIT License\",\n      \"url\": \"https://api.github.com/licenses/mit\",\n      \"spdx_id\": \"MIT\",\n      \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n      \"html_url\": \"https://api.github.com/licenses/mit\"\n    },\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"allow_rebase_merge\": true,\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"allow_squash_merge\": true,\n    \"delete_branch_on_merge\": true,\n    \"allow_merge_commit\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0\n  },\n  \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n  \"allow_squash_merge\": true,\n  \"delete_branch_on_merge\": true,\n  \"allow_merge_commit\": true,\n  \"subscribers_count\": 42,\n  \"network_count\": 0,\n  \"license\": {\n    \"key\": \"mit\",\n    \"name\": \"MIT License\",\n    \"spdx_id\": \"MIT\",\n    \"url\": \"https://api.github.com/licenses/mit\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n  },\n  \"organization\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"Organization\",\n    \"site_admin\": false\n  },\n  \"parent\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": true,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"allow_rebase_merge\": true,\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"allow_squash_merge\": true,\n    \"delete_branch_on_merge\": true,\n    \"allow_merge_commit\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0,\n    \"license\": {\n      \"key\": \"mit\",\n      \"name\": \"MIT License\",\n      \"url\": \"https://api.github.com/licenses/mit\",\n      \"spdx_id\": \"MIT\",\n      \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n      \"html_url\": \"https://api.github.com/licenses/mit\"\n    },\n    \"forks\": 1,\n    \"open_issues\": 1,\n    \"watchers\": 1\n  },\n  \"source\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": true,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"allow_rebase_merge\": true,\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"allow_squash_merge\": true,\n    \"delete_branch_on_merge\": true,\n    \"allow_merge_commit\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0,\n    \"license\": {\n      \"key\": \"mit\",\n      \"name\": \"MIT License\",\n      \"url\": \"https://api.github.com/licenses/mit\",\n      \"spdx_id\": \"MIT\",\n      \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n      \"html_url\": \"https://api.github.com/licenses/mit\"\n    },\n    \"forks\": 1,\n    \"open_issues\": 1,\n    \"watchers\": 1\n  }\n}\n
" + }, + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Response with scarlet-witch-preview media type", + "payload": "
{\n  \"id\": 1296269,\n  \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n  \"name\": \"Hello-World\",\n  \"full_name\": \"octocat/Hello-World\",\n  \"owner\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"private\": false,\n  \"html_url\": \"https://github.com/octocat/Hello-World\",\n  \"description\": \"This your first repo!\",\n  \"fork\": false,\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n  \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n  \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n  \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n  \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n  \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n  \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n  \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n  \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n  \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n  \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n  \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n  \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n  \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n  \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n  \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n  \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n  \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n  \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n  \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n  \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n  \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n  \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n  \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n  \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n  \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n  \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n  \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n  \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n  \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n  \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n  \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n  \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n  \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n  \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n  \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n  \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n  \"homepage\": \"https://github.com\",\n  \"language\": null,\n  \"forks_count\": 9,\n  \"forks\": 9,\n  \"stargazers_count\": 80,\n  \"watchers_count\": 80,\n  \"watchers\": 80,\n  \"size\": 108,\n  \"default_branch\": \"master\",\n  \"open_issues_count\": 0,\n  \"open_issues\": 0,\n  \"is_template\": false,\n  \"topics\": [\n    \"octocat\",\n    \"atom\",\n    \"electron\",\n    \"api\"\n  ],\n  \"has_issues\": true,\n  \"has_projects\": true,\n  \"has_wiki\": true,\n  \"has_pages\": false,\n  \"has_downloads\": true,\n  \"archived\": false,\n  \"disabled\": false,\n  \"visibility\": \"public\",\n  \"pushed_at\": \"2011-01-26T19:06:43Z\",\n  \"created_at\": \"2011-01-26T19:01:12Z\",\n  \"updated_at\": \"2011-01-26T19:14:43Z\",\n  \"permissions\": {\n    \"pull\": true,\n    \"push\": false,\n    \"admin\": false\n  },\n  \"allow_rebase_merge\": true,\n  \"template_repository\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World-Template\",\n    \"full_name\": \"octocat/Hello-World-Template\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World-Template\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World-Template\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World-Template.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World-Template.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World-Template.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World-Template\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World-Template\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks\": 9,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"watchers\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues\": 0,\n    \"open_issues_count\": 0,\n    \"is_template\": true,\n    \"license\": {\n      \"key\": \"mit\",\n      \"name\": \"MIT License\",\n      \"url\": \"https://api.github.com/licenses/mit\",\n      \"spdx_id\": \"MIT\",\n      \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n      \"html_url\": \"https://api.github.com/licenses/mit\"\n    },\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"allow_rebase_merge\": true,\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"allow_squash_merge\": true,\n    \"delete_branch_on_merge\": true,\n    \"allow_merge_commit\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0\n  },\n  \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n  \"allow_squash_merge\": true,\n  \"delete_branch_on_merge\": true,\n  \"allow_merge_commit\": true,\n  \"subscribers_count\": 42,\n  \"network_count\": 0,\n  \"license\": {\n    \"key\": \"mit\",\n    \"name\": \"MIT License\",\n    \"spdx_id\": \"MIT\",\n    \"url\": \"https://api.github.com/licenses/mit\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n  },\n  \"organization\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"Organization\",\n    \"site_admin\": false\n  },\n  \"parent\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": true,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"allow_rebase_merge\": true,\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"allow_squash_merge\": true,\n    \"delete_branch_on_merge\": true,\n    \"allow_merge_commit\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0,\n    \"license\": {\n      \"key\": \"mit\",\n      \"name\": \"MIT License\",\n      \"url\": \"https://api.github.com/licenses/mit\",\n      \"spdx_id\": \"MIT\",\n      \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n      \"html_url\": \"https://api.github.com/licenses/mit\"\n    },\n    \"forks\": 1,\n    \"open_issues\": 1,\n    \"watchers\": 1\n  },\n  \"source\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": true,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"allow_rebase_merge\": true,\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"allow_squash_merge\": true,\n    \"delete_branch_on_merge\": true,\n    \"allow_merge_commit\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0,\n    \"license\": {\n      \"key\": \"mit\",\n      \"name\": \"MIT License\",\n      \"url\": \"https://api.github.com/licenses/mit\",\n      \"spdx_id\": \"MIT\",\n      \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n      \"html_url\": \"https://api.github.com/licenses/mit\"\n    },\n    \"forks\": 1,\n    \"open_issues\": 1,\n    \"watchers\": 1\n  },\n  \"code_of_conduct\": {\n    \"key\": \"other\",\n    \"name\": \"Other\",\n    \"html_url\": \"https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md\",\n    \"url\": \"https://api.github.com/repos/github/docs/community/code_of_conduct\"\n  }\n}\n
" + }, + { + "httpStatusCode": "301", + "httpStatusMessage": "Moved Permanently", + "description": "Moved permanently" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" } ] }, { - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", + "name": "owner", "in": "path", "required": true, "schema": { @@ -17288,17 +24902,7 @@ "descriptionHTML": "" }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

team_slug parameter

" - }, - { - "name": "username", + "name": "repo", "in": "path", "required": true, "schema": { @@ -17310,73 +24914,405 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME
" + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world \\\n -d '{\"name\":\"name\"}'", + "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world \\\n  -d '{\"name\":\"name\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/memberships/{username}', {\n org: 'org',\n team_slug: 'team_slug',\n username: 'username'\n})", - "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/memberships/{username}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  username: 'username'\n})\n
" + "source": "await octokit.request('PATCH /repos/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name'\n})", + "html": "
await octokit.request('PATCH /repos/{owner}/{repo}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  name: 'name'\n})\n
" } ], - "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-team).", + "summary": "Update a repository", + "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/github-ae@latest/rest/reference/repos#replace-all-repository-topics) endpoint.", "tags": [ - "teams" + "repos" ], - "operationId": "teams/get-membership-for-user-in-org", + "operationId": "repos/update", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#get-team-membership-for-a-user" + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#update-a-repository" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "

The name of the repository.

", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the repository.", + "childParamsGroups": [] + }, + "description": { + "type": "string", + "description": "

A short description of the repository.

", + "name": "description", + "in": "body", + "rawType": "string", + "rawDescription": "A short description of the repository.", + "childParamsGroups": [] + }, + "homepage": { + "type": "string", + "description": "

A URL with more information about the repository.

", + "name": "homepage", + "in": "body", + "rawType": "string", + "rawDescription": "A URL with more information about the repository.", + "childParamsGroups": [] + }, + "private": { + "type": "boolean", + "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", + "default": false, + "name": "private", + "in": "body", + "rawType": "boolean", + "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "childParamsGroups": [] + }, + "visibility": { + "type": "string", + "description": "

Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. The visibility parameter overrides the private parameter when you use both along with the nebula-preview preview header.

", + "enum": [ + "public", + "private", + "visibility", + "internal" + ], + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header.", + "childParamsGroups": [] + }, + "has_issues": { + "type": "boolean", + "description": "

Either true to enable issues for this repository or false to disable them.

", + "default": true, + "name": "has_issues", + "in": "body", + "rawType": "boolean", + "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", + "childParamsGroups": [] + }, + "has_projects": { + "type": "boolean", + "description": "

Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

", + "default": true, + "name": "has_projects", + "in": "body", + "rawType": "boolean", + "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", + "childParamsGroups": [] + }, + "has_wiki": { + "type": "boolean", + "description": "

Either true to enable the wiki for this repository or false to disable it.

", + "default": true, + "name": "has_wiki", + "in": "body", + "rawType": "boolean", + "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "childParamsGroups": [] + }, + "is_template": { + "type": "boolean", + "description": "

Either true to make this repo available as a template repository or false to prevent it.

", + "default": false, + "name": "is_template", + "in": "body", + "rawType": "boolean", + "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "childParamsGroups": [] + }, + "default_branch": { + "type": "string", + "description": "

Updates the default branch for this repository.

", + "name": "default_branch", + "in": "body", + "rawType": "string", + "rawDescription": "Updates the default branch for this repository.", + "childParamsGroups": [] + }, + "allow_squash_merge": { + "type": "boolean", + "description": "

Either true to allow squash-merging pull requests, or false to prevent squash-merging.

", + "default": true, + "name": "allow_squash_merge", + "in": "body", + "rawType": "boolean", + "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "childParamsGroups": [] + }, + "allow_merge_commit": { + "type": "boolean", + "description": "

Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

", + "default": true, + "name": "allow_merge_commit", + "in": "body", + "rawType": "boolean", + "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "childParamsGroups": [] + }, + "allow_rebase_merge": { + "type": "boolean", + "description": "

Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

", + "default": true, + "name": "allow_rebase_merge", + "in": "body", + "rawType": "boolean", + "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "childParamsGroups": [] + }, + "delete_branch_on_merge": { + "type": "boolean", + "description": "

Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

", + "default": false, + "name": "delete_branch_on_merge", + "in": "body", + "rawType": "boolean", + "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", + "childParamsGroups": [] + }, + "archived": { + "type": "boolean", + "description": "

true to archive this repository. Note: You cannot unarchive repositories through the API.

", + "default": false, + "name": "archived", + "in": "body", + "rawType": "boolean", + "rawDescription": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", + "childParamsGroups": [] + } + } + }, + "example": { + "name": "Hello-World", + "description": "This is your first repository", + "homepage": "https://github.com", + "private": true, + "has_issues": true, + "has_projects": true, + "has_wiki": true + } + } + } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [], - "category": "teams", - "subcategory": "members" + "previews": [ + { + "required": false, + "name": "nebula", + "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```", + "html": "

You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.

\n

To access repository visibility during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.nebula-preview+json
" + }, + { + "required": false, + "name": "baptiste", + "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```", + "html": "

The is_template and template_repository keys are currently available for developer to preview. See Create a repository using a template to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json
" + } + ], + "category": "repos", + "subcategory": null }, - "slug": "get-team-membership-for-a-user", - "category": "teams", - "categoryLabel": "Teams", - "subcategory": "members", - "subcategoryLabel": "Members", + "slug": "update-a-repository", + "category": "repos", + "categoryLabel": "Repos", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Team members will include the members of child teams.

\n

To get a user's membership with a team, the team must be visible to the authenticated user.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/memberships/{username}.

\n

Note: The role for organization owners returns as maintainer. For more information about maintainer roles, see Create a team.

", - "responses": [ + "descriptionHTML": "

Note: To edit a repository's topics, use the Replace all repository topics endpoint.

", + "bodyParameters": [ + { + "type": "string", + "description": "

The name of the repository.

", + "name": "name", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the repository.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

A short description of the repository.

", + "name": "description", + "in": "body", + "rawType": "string", + "rawDescription": "A short description of the repository.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

A URL with more information about the repository.

", + "name": "homepage", + "in": "body", + "rawType": "string", + "rawDescription": "A URL with more information about the repository.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", + "default": false, + "name": "private", + "in": "body", + "rawType": "boolean", + "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. The visibility parameter overrides the private parameter when you use both along with the nebula-preview preview header.

", + "enum": [ + "public", + "private", + "visibility", + "internal" + ], + "name": "visibility", + "in": "body", + "rawType": "string", + "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Either true to enable issues for this repository or false to disable them.

", + "default": true, + "name": "has_issues", + "in": "body", + "rawType": "boolean", + "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

", + "default": true, + "name": "has_projects", + "in": "body", + "rawType": "boolean", + "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Either true to enable the wiki for this repository or false to disable it.

", + "default": true, + "name": "has_wiki", + "in": "body", + "rawType": "boolean", + "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Either true to make this repo available as a template repository or false to prevent it.

", + "default": false, + "name": "is_template", + "in": "body", + "rawType": "boolean", + "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

Updates the default branch for this repository.

", + "name": "default_branch", + "in": "body", + "rawType": "string", + "rawDescription": "Updates the default branch for this repository.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Either true to allow squash-merging pull requests, or false to prevent squash-merging.

", + "default": true, + "name": "allow_squash_merge", + "in": "body", + "rawType": "boolean", + "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

", + "default": true, + "name": "allow_merge_commit", + "in": "body", + "rawType": "boolean", + "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

", + "default": true, + "name": "allow_rebase_merge", + "in": "body", + "rawType": "boolean", + "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "childParamsGroups": [] + }, { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has an active membership with team", - "payload": "
{\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
" + "type": "boolean", + "description": "

Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

", + "default": false, + "name": "delete_branch_on_merge", + "in": "body", + "rawType": "boolean", + "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", + "childParamsGroups": [] }, + { + "type": "boolean", + "description": "

true to archive this repository. Note: You cannot unarchive repositories through the API.

", + "default": false, + "name": "archived", + "in": "body", + "rawType": "boolean", + "rawDescription": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", + "childParamsGroups": [] + } + ], + "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "Response if user is a team maintainer", - "payload": "
{\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"maintainer\",\n  \"state\": \"active\"\n}\n
" + "description": "Default response", + "payload": "
{\n  \"id\": 1296269,\n  \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n  \"name\": \"Hello-World\",\n  \"full_name\": \"octocat/Hello-World\",\n  \"owner\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"private\": false,\n  \"html_url\": \"https://github.com/octocat/Hello-World\",\n  \"description\": \"This your first repo!\",\n  \"fork\": false,\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n  \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n  \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n  \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n  \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n  \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n  \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n  \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n  \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n  \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n  \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n  \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n  \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n  \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n  \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n  \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n  \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n  \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n  \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n  \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n  \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n  \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n  \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n  \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n  \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n  \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n  \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n  \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n  \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n  \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n  \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n  \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n  \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n  \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n  \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n  \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n  \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n  \"homepage\": \"https://github.com\",\n  \"license\": {\n    \"key\": \"mit\",\n    \"name\": \"MIT License\",\n    \"url\": \"https://api.github.com/licenses/mit\",\n    \"spdx_id\": \"MIT\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n    \"html_url\": \"https://github.com/licenses/mit\"\n  },\n  \"language\": null,\n  \"forks_count\": 9,\n  \"forks\": 9,\n  \"stargazers_count\": 80,\n  \"watchers_count\": 80,\n  \"watchers\": 80,\n  \"size\": 108,\n  \"default_branch\": \"master\",\n  \"open_issues_count\": 0,\n  \"open_issues\": 0,\n  \"is_template\": false,\n  \"topics\": [\n    \"octocat\",\n    \"atom\",\n    \"electron\",\n    \"api\"\n  ],\n  \"has_issues\": true,\n  \"has_projects\": true,\n  \"has_wiki\": true,\n  \"has_pages\": false,\n  \"has_downloads\": true,\n  \"archived\": false,\n  \"disabled\": false,\n  \"visibility\": \"public\",\n  \"pushed_at\": \"2011-01-26T19:06:43Z\",\n  \"created_at\": \"2011-01-26T19:01:12Z\",\n  \"updated_at\": \"2011-01-26T19:14:43Z\",\n  \"permissions\": {\n    \"pull\": true,\n    \"push\": false,\n    \"admin\": false\n  },\n  \"allow_rebase_merge\": true,\n  \"template_repository\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World-Template\",\n    \"full_name\": \"octocat/Hello-World-Template\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World-Template\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World-Template\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World-Template.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World-Template.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World-Template.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World-Template\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World-Template\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks\": 9,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"watchers\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues\": 0,\n    \"open_issues_count\": 0,\n    \"is_template\": true,\n    \"license\": {\n      \"key\": \"mit\",\n      \"name\": \"MIT License\",\n      \"url\": \"https://api.github.com/licenses/mit\",\n      \"spdx_id\": \"MIT\",\n      \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n      \"html_url\": \"https://api.github.com/licenses/mit\"\n    },\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"allow_rebase_merge\": true,\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"allow_squash_merge\": true,\n    \"delete_branch_on_merge\": true,\n    \"allow_merge_commit\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0\n  },\n  \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n  \"allow_squash_merge\": true,\n  \"delete_branch_on_merge\": true,\n  \"allow_merge_commit\": true,\n  \"subscribers_count\": 42,\n  \"network_count\": 0,\n  \"organization\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"Organization\",\n    \"site_admin\": false\n  },\n  \"parent\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": true,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"allow_rebase_merge\": true,\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"allow_squash_merge\": true,\n    \"delete_branch_on_merge\": true,\n    \"allow_merge_commit\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0,\n    \"license\": {\n      \"key\": \"mit\",\n      \"name\": \"MIT License\",\n      \"url\": \"https://api.github.com/licenses/mit\",\n      \"spdx_id\": \"MIT\",\n      \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n      \"html_url\": \"https://api.github.com/licenses/mit\"\n    },\n    \"forks\": 1,\n    \"open_issues\": 1,\n    \"watchers\": 1\n  },\n  \"source\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": true,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"allow_rebase_merge\": true,\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"allow_squash_merge\": true,\n    \"delete_branch_on_merge\": true,\n    \"allow_merge_commit\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0,\n    \"license\": {\n      \"key\": \"mit\",\n      \"name\": \"MIT License\",\n      \"url\": \"https://api.github.com/licenses/mit\",\n      \"spdx_id\": \"MIT\",\n      \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n      \"html_url\": \"https://api.github.com/licenses/mit\"\n    },\n    \"forks\": 1,\n    \"open_issues\": 1,\n    \"watchers\": 1\n  }\n}\n
" }, { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user has a pending membership with team", - "payload": "
{\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"pending\"\n}\n
" + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Forbidden" }, { "httpStatusCode": "404", "httpStatusMessage": "Not Found", - "description": "Response if user has no team membership" + "description": "Resource not found" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation failed" } ] }, { - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", + "name": "owner", "in": "path", "required": true, "schema": { @@ -17385,17 +25321,7 @@ "descriptionHTML": "" }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

team_slug parameter

" - }, - { - "name": "username", + "name": "repo", "in": "path", "required": true, "schema": { @@ -17407,113 +25333,64 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \\\n -d '{\"role\":\"role\"}'", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME \\\n  -d '{\"role\":\"role\"}'
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /orgs/{org}/teams/{team_slug}/memberships/{username}', {\n org: 'org',\n team_slug: 'team_slug',\n username: 'username',\n role: 'role'\n})", - "html": "
await octokit.request('PUT /orgs/{org}/teams/{team_slug}/memberships/{username}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  username: 'username',\n  role: 'role'\n})\n
" + "source": "await octokit.request('DELETE /repos/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
await octokit.request('DELETE /repos/{owner}/{repo}', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" } ], - "summary": "Add or update team membership for a user", - "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\n**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 AE 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 AE](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "summary": "Delete a repository", + "description": "Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a `403 Forbidden` response.", "tags": [ - "teams" + "repos" ], - "operationId": "teams/add-or-update-membership-for-user-in-org", + "operationId": "repos/delete", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#add-or-update-team-membership-for-a-user" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "role": { - "type": "string", - "description": "

The role that this user should have in the team. Can be one of:
\n* member - a normal member of the team.
\n* maintainer - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.

", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "name": "role", - "in": "body", - "rawType": "string", - "rawDescription": "The role that this user should have in the team. Can be one of: \n\\* `member` - a normal member of the team. \n\\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.", - "childParamsGroups": [] - } - } - } - } - } + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#delete-a-repository" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "category": "teams", - "subcategory": "members" + "category": "repos", + "subcategory": null }, - "slug": "add-or-update-team-membership-for-a-user", - "category": "teams", - "categoryLabel": "Teams", - "subcategory": "members", - "subcategoryLabel": "Members", + "slug": "delete-a-repository", + "category": "repos", + "categoryLabel": "Repos", "notes": [], - "descriptionHTML": "

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

Adds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.

\n

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 AE 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 AE.\"

\n

An organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.

\n

If the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.

\n

Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/memberships/{username}.

", - "bodyParameters": [ - { - "type": "string", - "description": "

The role that this user should have in the team. Can be one of:
\n* member - a normal member of the team.
\n* maintainer - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.

", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "name": "role", - "in": "body", - "rawType": "string", - "rawDescription": "The role that this user should have in the team. Can be one of: \n\\* `member` - a normal member of the team. \n\\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.", - "childParamsGroups": [] - } - ], + "bodyParameters": [], + "descriptionHTML": "

Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.

\n

If an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a 403 Forbidden response.

", "responses": [ { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user's membership with team is now active", - "payload": "
{\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"active\"\n}\n
" - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response if user's membership with team is now pending", - "payload": "
{\n  \"url\": \"https://api.github.com/teams/1/memberships/octocat\",\n  \"role\": \"member\",\n  \"state\": \"pending\"\n}\n
" + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" }, { "httpStatusCode": "403", "httpStatusMessage": "Forbidden", - "description": "Response if team synchronization is set up" + "description": "If an organization owner has configured the organization to prevent members from deleting organization owned repositories a member will get this response", + "payload": "
{\n  \"message\": \"Organization members cannot delete repositories.\",\n  \"documentation_url\": \"https://docs.github.com/github-ae@latest/rest/reference/repos#delete-a-repository\"\n}\n
" }, { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Response if you attempt to add an organization to a team", - "payload": "
{\n  \"message\": \"Cannot add an organization as a member.\",\n  \"errors\": [\n    {\n      \"code\": \"org\",\n      \"field\": \"user\",\n      \"resource\": \"TeamMember\"\n    }\n  ]\n}\n
" + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" } ] }, { - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/memberships/{username}", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/artifacts", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", + "name": "owner", "in": "path", "required": true, "schema": { @@ -17522,82 +25399,88 @@ "descriptionHTML": "" }, { - "name": "team_slug", - "description": "team_slug parameter", + "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

team_slug parameter

" + "descriptionHTML": "" }, { - "name": "username", - "in": "path", - "required": true, + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 30 }, - "descriptionHTML": "" + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/memberships/USERNAME
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/artifacts", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/artifacts
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}', {\n org: 'org',\n team_slug: 'team_slug',\n username: 'username'\n})", - "html": "
await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/memberships/{username}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  username: 'username'\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/artifacts', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/artifacts', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" } ], - "summary": "Remove team membership for a user", - "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**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 AE 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 AE](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "summary": "List artifacts for a repository", + "description": "Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ - "teams" + "actions" ], - "operationId": "teams/remove-membership-for-user-in-org", + "operationId": "actions/list-artifacts-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#remove-team-membership-for-a-user" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-artifacts-for-a-repository" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "category": "teams", - "subcategory": "members" + "category": "actions", + "subcategory": "artifacts" }, - "slug": "remove-team-membership-for-a-user", - "category": "teams", - "categoryLabel": "Teams", - "subcategory": "members", - "subcategoryLabel": "Members", + "slug": "list-artifacts-for-a-repository", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "artifacts", + "subcategoryLabel": "Artifacts", "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

", "responses": [ { - "httpStatusCode": "204", - "httpStatusMessage": "No Content", - "description": "Default Response" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Response if team synchronization is set up" + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"total_count\": 2,\n  \"artifacts\": [\n    {\n      \"id\": 11,\n      \"node_id\": \"MDg6QXJ0aWZhY3QxMQ==\",\n      \"name\": \"Rails\",\n      \"size_in_bytes\": 556,\n      \"url\": \"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\n      \"archive_download_url\": \"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\n      \"expired\": false,\n      \"created_at\": \"2020-01-10T14:59:22Z\",\n      \"expires_at\": \"2020-03-21T14:59:22Z\",\n      \"updated_at\": \"2020-02-21T14:59:22Z\"\n    },\n    {\n      \"id\": 13,\n      \"node_id\": \"MDg6QXJ0aWZhY3QxMw==\",\n      \"name\": \"\",\n      \"size_in_bytes\": 453,\n      \"url\": \"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\n      \"archive_download_url\": \"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\n      \"expired\": false,\n      \"created_at\": \"2020-01-10T14:59:22Z\",\n      \"expires_at\": \"2020-03-21T14:59:22Z\",\n      \"updated_at\": \"2020-02-21T14:59:22Z\"\n    }\n  ]\n}\n
" } - ], - "bodyParameters": [], - "descriptionHTML": "

Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see GitHub's products in the GitHub Help documentation.

\n

To remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.

\n

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 AE 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 AE.\"

\n

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}.

" + ] }, { "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects", + "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", + "name": "owner", "in": "path", "required": true, "schema": { @@ -17606,94 +25489,78 @@ "descriptionHTML": "" }, { - "name": "team_slug", - "description": "team_slug parameter", + "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

team_slug parameter

" - }, - { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - }, - "descriptionHTML": "

Results per page (max 100).

" + "descriptionHTML": "" }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", + "name": "artifact_id", + "description": "artifact_id parameter", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" }, - "descriptionHTML": "

Page number of the results to fetch.

" + "descriptionHTML": "

artifact_id parameter

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/artifacts/42", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/artifacts/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/projects', {\n org: 'org',\n team_slug: 'team_slug',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/projects', {\n  org: 'org',\n  team_slug: 'team_slug',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n artifact_id: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  artifact_id: 42\n})\n
" } ], - "summary": "List team projects", - "description": "Lists the organization projects for a team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.", + "summary": "Get an artifact", + "description": "Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ - "teams" + "actions" ], - "operationId": "teams/list-projects-in-org", + "operationId": "actions/get-artifact", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#list-team-projects" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-artifact" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "teams", - "subcategory": null + "previews": [], + "category": "actions", + "subcategory": "artifacts" }, - "slug": "list-team-projects", - "category": "teams", - "categoryLabel": "Teams", + "slug": "get-an-artifact", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "artifacts", + "subcategoryLabel": "Artifacts", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Lists the organization projects for a team.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects.

", + "descriptionHTML": "

Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"owner_url\": \"https://api.github.com/orgs/octocat\",\n    \"url\": \"https://api.github.com/projects/1002605\",\n    \"html_url\": \"https://github.com/orgs/api-playground/projects/1\",\n    \"columns_url\": \"https://api.github.com/projects/1002605/columns\",\n    \"id\": 1002605,\n    \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDU=\",\n    \"name\": \"Organization Roadmap\",\n    \"body\": \"High-level roadmap for the upcoming year.\",\n    \"number\": 1,\n    \"state\": \"open\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"created_at\": \"2011-04-11T20:09:31Z\",\n    \"updated_at\": \"2014-03-04T18:58:10Z\",\n    \"organization_permission\": \"write\",\n    \"private\": false,\n    \"permissions\": {\n      \"read\": true,\n      \"write\": true,\n      \"admin\": false\n    }\n  }\n]\n
" + "payload": "
{\n  \"id\": 11,\n  \"node_id\": \"MDg6QXJ0aWZhY3QxMQ==\",\n  \"name\": \"Rails\",\n  \"size_in_bytes\": 556,\n  \"url\": \"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\n  \"archive_download_url\": \"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\n  \"expired\": false,\n  \"created_at\": \"2020-01-10T14:59:22Z\",\n  \"expires_at\": \"2020-01-21T14:59:22Z\",\n  \"updated_at\": \"2020-01-21T14:59:22Z\"\n}\n
" } ] }, { - "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", + "name": "owner", "in": "path", "required": true, "schema": { @@ -17702,88 +25569,77 @@ "descriptionHTML": "" }, { - "name": "team_slug", - "description": "team_slug parameter", + "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

team_slug parameter

" + "descriptionHTML": "" }, { - "name": "project_id", + "name": "artifact_id", + "description": "artifact_id parameter", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "" + "descriptionHTML": "

artifact_id parameter

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/artifacts/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/artifacts/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/projects/{project_id}', {\n org: 'org',\n team_slug: 'team_slug',\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/projects/{project_id}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  project_id: 42,\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n artifact_id: 42\n})", + "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/actions/artifacts/{artifact_id}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  artifact_id: 42\n})\n
" } ], - "summary": "Check team permissions for a project", - "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "summary": "Delete an artifact", + "description": "Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", "tags": [ - "teams" + "actions" ], - "operationId": "teams/check-permissions-for-project-in-org", + "operationId": "actions/delete-artifact", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#check-team-permissions-for-a-project" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-an-artifact" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "teams", - "subcategory": null + "previews": [], + "category": "actions", + "subcategory": "artifacts" }, - "slug": "check-team-permissions-for-a-project", - "category": "teams", - "categoryLabel": "Teams", + "slug": "delete-an-artifact", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "artifacts", + "subcategoryLabel": "Artifacts", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Checks whether a team has read, write, or admin permissions for an organization project. The response includes projects inherited from a parent team.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/projects/{project_id}.

", "responses": [ { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Default response", - "payload": "
{\n  \"owner_url\": \"https://api.github.com/orgs/octocat\",\n  \"url\": \"https://api.github.com/projects/1002605\",\n  \"html_url\": \"https://github.com/orgs/api-playground/projects/1\",\n  \"columns_url\": \"https://api.github.com/projects/1002605/columns\",\n  \"id\": 1002605,\n  \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDU=\",\n  \"name\": \"Organization Roadmap\",\n  \"body\": \"High-level roadmap for the upcoming year.\",\n  \"number\": 1,\n  \"state\": \"open\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2011-04-11T20:09:31Z\",\n  \"updated_at\": \"2014-03-04T18:58:10Z\",\n  \"organization_permission\": \"write\",\n  \"private\": false,\n  \"permissions\": {\n    \"read\": true,\n    \"write\": true,\n    \"admin\": false\n  }\n}\n
" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Response if project is not managed by this team" + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

Deletes an artifact for a workflow run. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

" }, { - "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", + "name": "owner", "in": "path", "required": true, "schema": { @@ -17792,129 +25648,86 @@ "descriptionHTML": "" }, { - "name": "team_slug", - "description": "team_slug parameter", + "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

team_slug parameter

" + "descriptionHTML": "" }, { - "name": "project_id", + "name": "artifact_id", + "description": "artifact_id parameter", "in": "path", "required": true, "schema": { "type": "integer" }, + "descriptionHTML": "

artifact_id parameter

" + }, + { + "name": "archive_format", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, "descriptionHTML": "" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42 \\\n -d '{\"permission\":\"permission\"}'", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42 \\\n  -d '{\"permission\":\"permission\"}'
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/artifacts/42/ARCHIVE_FORMAT", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/artifacts/42/ARCHIVE_FORMAT
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}', {\n org: 'org',\n team_slug: 'team_slug',\n project_id: 42,\n permission: 'permission',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('PUT /orgs/{org}/teams/{team_slug}/projects/{project_id}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  project_id: 42,\n  permission: 'permission',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}', {\n owner: 'octocat',\n repo: 'hello-world',\n artifact_id: 42,\n archive_format: 'archive_format'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  artifact_id: 42,\n  archive_format: 'archive_format'\n})\n
" } ], - "summary": "Add or update team project permissions", - "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "summary": "Download an artifact", + "description": "Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in\nthe response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ - "teams" + "actions" ], - "operationId": "teams/add-or-update-project-permissions-in-org", + "operationId": "actions/download-artifact", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#add-or-update-team-project-permissions" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "

The permission to grant to the team for this project. Can be one of:
\n* read - team members can read, but not write to or administer this project.
\n* write - team members can read and write, but not administer this project.
\n* admin - team members can read, write and administer this project.
\nDefault: the team's permission attribute will be used to determine what permission to grant the team on this project. 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.\"

", - "enum": [ - "read", - "write", - "admin" - ], - "name": "permission", - "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. 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](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "childParamsGroups": [] - } - }, - "nullable": true - } - } - } + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#download-an-artifact" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "teams", - "subcategory": null + "previews": [], + "category": "actions", + "subcategory": "artifacts" }, - "slug": "add-or-update-team-project-permissions", - "category": "teams", - "categoryLabel": "Teams", + "slug": "download-an-artifact", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "artifacts", + "subcategoryLabel": "Artifacts", "notes": [], - "descriptionHTML": "

Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have admin permissions for the project. The project and team must be part of the same organization.

\n

Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}.

", - "bodyParameters": [ - { - "type": "string", - "description": "

The permission to grant to the team for this project. Can be one of:
\n* read - team members can read, but not write to or administer this project.
\n* write - team members can read and write, but not administer this project.
\n* admin - team members can read, write and administer this project.
\nDefault: the team's permission attribute will be used to determine what permission to grant the team on this project. 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.\"

", - "enum": [ - "read", - "write", - "admin" - ], - "name": "permission", - "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. 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](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "childParamsGroups": [] - } - ], "responses": [ { - "httpStatusCode": "204", - "httpStatusMessage": "No Content", - "description": "Default Response" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Response if the project is not owned by the organization", - "payload": "
{\n  \"message\": \"Must have admin rights to Repository.\",\n  \"documentation_url\": \"https://docs.github.com/github-ae@latest/rest/reference/teams#add-or-update-team-project-permissions\"\n}\n
" + "httpStatusCode": "302", + "httpStatusMessage": "Found", + "description": "Response" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for Location: in\nthe response header to find the URL for the download. The :archive_format must be zip. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the repo scope.\nGitHub Apps must have the actions:read permission to use this endpoint.

" }, { - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/projects/{project_id}", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", + "name": "owner", "in": "path", "required": true, "schema": { @@ -17923,75 +25736,78 @@ "descriptionHTML": "" }, { - "name": "team_slug", - "description": "team_slug parameter", + "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

team_slug parameter

" + "descriptionHTML": "" }, { - "name": "project_id", + "name": "job_id", + "description": "job_id parameter", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "" + "descriptionHTML": "

job_id parameter

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/projects/42
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/jobs/42", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/jobs/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}', {\n org: 'org',\n team_slug: 'team_slug',\n project_id: 42\n})", - "html": "
await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/projects/{project_id}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  project_id: 42\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/jobs/{job_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n job_id: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/jobs/{job_id}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  job_id: 42\n})\n
" } ], - "summary": "Remove a project from a team", - "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "summary": "Get a job for a workflow run", + "description": "Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ - "teams" + "actions" ], - "operationId": "teams/remove-project-in-org", + "operationId": "actions/get-job-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#remove-a-project-from-a-team" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-job-for-a-workflow-run" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "category": "teams", - "subcategory": null + "category": "actions", + "subcategory": "workflow-jobs" }, - "slug": "remove-a-project-from-a-team", - "category": "teams", - "categoryLabel": "Teams", + "slug": "get-a-job-for-a-workflow-run", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-jobs", + "subcategoryLabel": "Workflow jobs", "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

", "responses": [ { - "httpStatusCode": "204", - "httpStatusMessage": "No Content", - "description": "Default Response" + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Default response", + "payload": "
{\n  \"id\": 399444496,\n  \"run_id\": 29679449,\n  \"run_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\n  \"node_id\": \"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\n  \"head_sha\": \"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\n  \"url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\n  \"html_url\": \"https://github.com/octo-org/octo-repo/runs/399444496\",\n  \"status\": \"completed\",\n  \"conclusion\": \"success\",\n  \"started_at\": \"2020-01-20T17:42:40Z\",\n  \"completed_at\": \"2020-01-20T17:44:39Z\",\n  \"name\": \"build\",\n  \"steps\": [\n    {\n      \"name\": \"Set up job\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"number\": 1,\n      \"started_at\": \"2020-01-20T09:42:40.000-08:00\",\n      \"completed_at\": \"2020-01-20T09:42:41.000-08:00\"\n    },\n    {\n      \"name\": \"Run actions/checkout@v2\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"number\": 2,\n      \"started_at\": \"2020-01-20T09:42:41.000-08:00\",\n      \"completed_at\": \"2020-01-20T09:42:45.000-08:00\"\n    },\n    {\n      \"name\": \"Set up Ruby\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"number\": 3,\n      \"started_at\": \"2020-01-20T09:42:45.000-08:00\",\n      \"completed_at\": \"2020-01-20T09:42:45.000-08:00\"\n    },\n    {\n      \"name\": \"Run actions/cache@v2\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"number\": 4,\n      \"started_at\": \"2020-01-20T09:42:45.000-08:00\",\n      \"completed_at\": \"2020-01-20T09:42:48.000-08:00\"\n    },\n    {\n      \"name\": \"Install Bundler\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"number\": 5,\n      \"started_at\": \"2020-01-20T09:42:48.000-08:00\",\n      \"completed_at\": \"2020-01-20T09:42:52.000-08:00\"\n    },\n    {\n      \"name\": \"Install Gems\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"number\": 6,\n      \"started_at\": \"2020-01-20T09:42:52.000-08:00\",\n      \"completed_at\": \"2020-01-20T09:42:53.000-08:00\"\n    },\n    {\n      \"name\": \"Run Tests\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"number\": 7,\n      \"started_at\": \"2020-01-20T09:42:53.000-08:00\",\n      \"completed_at\": \"2020-01-20T09:42:59.000-08:00\"\n    },\n    {\n      \"name\": \"Deploy to Heroku\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"number\": 8,\n      \"started_at\": \"2020-01-20T09:42:59.000-08:00\",\n      \"completed_at\": \"2020-01-20T09:44:39.000-08:00\"\n    },\n    {\n      \"name\": \"Post actions/cache@v2\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"number\": 16,\n      \"started_at\": \"2020-01-20T09:44:39.000-08:00\",\n      \"completed_at\": \"2020-01-20T09:44:39.000-08:00\"\n    },\n    {\n      \"name\": \"Complete job\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"number\": 17,\n      \"started_at\": \"2020-01-20T09:44:39.000-08:00\",\n      \"completed_at\": \"2020-01-20T09:44:39.000-08:00\"\n    }\n  ],\n  \"check_run_url\": \"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\"\n}\n
" } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have read access to both the team and project, or admin access to the team or project. This endpoint removes the project from the team, but does not delete the project.

\n

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}.

" + ] }, { "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos", + "requestPath": "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", + "name": "owner", "in": "path", "required": true, "schema": { @@ -18000,104 +25816,75 @@ "descriptionHTML": "" }, { - "name": "team_slug", - "description": "team_slug parameter", + "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

team_slug parameter

" - }, - { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - }, - "descriptionHTML": "

Results per page (max 100).

" + "descriptionHTML": "" }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", + "name": "job_id", + "description": "job_id parameter", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" }, - "descriptionHTML": "

Page number of the results to fetch.

" + "descriptionHTML": "

job_id parameter

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/jobs/42/logs", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/jobs/42/logs
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/repos', {\n org: 'org',\n team_slug: 'team_slug'\n})", - "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/repos', {\n  org: 'org',\n  team_slug: 'team_slug'\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs', {\n owner: 'octocat',\n repo: 'hello-world',\n job_id: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/jobs/{job_id}/logs', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  job_id: 42\n})\n
" } ], - "summary": "List team repositories", - "description": "Lists a team's repositories visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", + "summary": "Download job logs for a workflow run", + "description": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can\nuse this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must\nhave the `actions:read` permission to use this endpoint.", "tags": [ - "teams" + "actions" ], - "operationId": "teams/list-repos-in-org", + "operationId": "actions/download-job-logs-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#list-team-repositories" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#download-job-logs-for-a-workflow-run" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "category": "teams", - "subcategory": null + "category": "actions", + "subcategory": "workflow-jobs" }, - "slug": "list-team-repositories", - "category": "teams", - "categoryLabel": "Teams", + "slug": "download-job-logs-for-a-workflow-run", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-jobs", + "subcategoryLabel": "Workflow jobs", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Lists a team's repositories visible to the authenticated user.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos.

", "responses": [ { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Default response", - "payload": "
[\n  {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": false,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"template_repository\": {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World-Template\",\n      \"full_name\": \"octocat/Hello-World-Template\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World-Template\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World-Template\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World-Template.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World-Template.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World-Template.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World-Template\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World-Template\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks\": 9,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"watchers\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues\": 0,\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://api.github.com/licenses/mit\"\n      },\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0\n    }\n  }\n]\n
" + "httpStatusCode": "302", + "httpStatusMessage": "Found", + "description": "Response" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor Location: in the response header to find the URL for the download. Anyone with read access to the repository can\nuse this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must\nhave the actions:read permission to use this endpoint.

" }, { "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", + "requestPath": "/repos/{owner}/{repo}/actions/permissions", "serverUrl": "https://api.github.com", "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

team_slug parameter

" - }, { "name": "owner", "in": "path", @@ -18120,80 +25907,54 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/permissions", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/permissions
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}', {\n org: 'org',\n team_slug: 'team_slug',\n owner: 'octocat',\n repo: 'hello-world'\n})", - "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/permissions', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/permissions', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" } ], - "summary": "Check team permissions for a repository", - "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "summary": "Get GitHub Actions permissions for a repository", + "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/get-github-actions-permissions-repository", "tags": [ - "teams" + "actions" ], - "operationId": "teams/check-permissions-for-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#check-team-permissions-for-a-repository" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-github-actions-permissions-for-a-repository" }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "previews": [], - "category": "teams", - "subcategory": null + "category": "actions", + "subcategory": "permissions" }, - "slug": "check-team-permissions-for-a-repository", - "category": "teams", - "categoryLabel": "Teams", + "slug": "get-github-actions-permissions-for-a-repository", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.

\n

You must authenticate using an access token with the repo scope to use this\nendpoint. GitHub Apps must have the administration repository permission to use this API.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "Alternative response with repository permissions" - }, - { - "httpStatusCode": "204", - "httpStatusMessage": "No Content", - "description": "Response if team has permission for the repository" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Response if team does not have permission for the repository" + "description": "Default response", + "payload": "
{\n  \"enabled\": true,\n  \"allowed_actions\": \"selected\",\n  \"selected_actions_url\": \"https://api.github.com/repositories/42/actions/permissions/selected-actions\"\n}\n
" } - ], - "bodyParameters": [], - "descriptionHTML": "

Checks whether a team has admin, push, maintain, triage, or pull permission for a repository. Repositories inherited through a parent team will also be checked.

\n

You can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom media type via the application/vnd.github.v3.repository+json accept header.

\n

If a team doesn't have permission for the repository, you will receive a 404 Not Found response status.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.

" + ] }, { "verb": "put", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", + "requestPath": "/repos/{owner}/{repo}/actions/permissions", "serverUrl": "https://api.github.com", "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "" - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - }, - "descriptionHTML": "

team_slug parameter

" - }, { "name": "owner", "in": "path", @@ -18216,24 +25977,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world \\\n -d '{\"permission\":\"permission\"}'", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world \\\n  -d '{\"permission\":\"permission\"}'
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/permissions \\\n -d '{\"enabled\":true}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/permissions \\\n  -d '{\"enabled\":true}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}', {\n org: 'org',\n team_slug: 'team_slug',\n owner: 'octocat',\n repo: 'hello-world',\n permission: 'permission'\n})", - "html": "
await octokit.request('PUT /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  owner: 'octocat',\n  repo: 'hello-world',\n  permission: 'permission'\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/actions/permissions', {\n owner: 'octocat',\n repo: 'hello-world',\n enabled: true\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/actions/permissions', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  enabled: true\n})\n
" } ], - "summary": "Add or update team repository permissions", - "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", + "summary": "Set GitHub Actions permissions for a repository", + "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.\n\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/set-github-actions-permissions-repository", "tags": [ - "teams" + "actions" ], - "operationId": "teams/add-or-update-repo-permissions-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#add-or-update-team-repository-permissions" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-github-actions-permissions-for-a-repository" }, "requestBody": { "content": { @@ -18241,37 +26002,53 @@ "schema": { "type": "object", "properties": { - "permission": { + "enabled": { + "type": "boolean", + "description": "

Required. Whether GitHub Actions is enabled on the repository.

", + "name": "enabled", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether GitHub Actions is enabled on the repository.", + "childParamsGroups": [] + }, + "allowed_actions": { "type": "string", - "description": "

The permission to grant the team on this repository. Can be one of:
\n* pull - team members can pull, but not push to or administer this repository.
\n* push - team members can pull and push, but not administer this repository.
\n* admin - team members can pull, push and administer this repository.
\n* maintain - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations.
\n* triage - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations.

\n

If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

", + "description": "

The permissions policy that controls the actions that are allowed to run. Can be one of: all, local_only, or selected.

", "enum": [ - "pull", - "push", - "admin", - "maintain", - "triage" + "all", + "local_only", + "selected" ], - "name": "permission", + "name": "allowed_actions", "in": "body", "rawType": "string", - "rawDescription": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n\\* `maintain` - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations. \n\\* `triage` - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", + "rawDescription": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", "childParamsGroups": [] } - } + }, + "required": [ + "enabled" + ] + }, + "example": { + "enabled": true, + "allowed_actions": "selected" } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "previews": [], - "category": "teams", - "subcategory": null + "category": "actions", + "subcategory": "permissions" }, - "slug": "add-or-update-team-repository-permissions", - "category": "teams", - "categoryLabel": "Teams", + "slug": "set-github-actions-permissions-for-a-repository", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", "notes": [], "responses": [ { @@ -18280,33 +26057,40 @@ "description": "Default Response" } ], - "descriptionHTML": "

To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a 422 Unprocessable Entity status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set Content-Length to zero when calling out to this endpoint. For more information, see \"HTTP verbs.\"

\n

Note: You can also specify a team by org_id and team_id using the route PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.

\n

For more information about the permission levels, see \"Repository permission levels for an organization\".

", + "descriptionHTML": "

Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.

\n

If the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as allowed_actions to selected actions, then you cannot override them for the repository.

\n

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.

", "bodyParameters": [ + { + "type": "boolean", + "description": "

Required. Whether GitHub Actions is enabled on the repository.

", + "name": "enabled", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether GitHub Actions is enabled on the repository.", + "childParamsGroups": [] + }, { "type": "string", - "description": "

The permission to grant the team on this repository. Can be one of:
\n* pull - team members can pull, but not push to or administer this repository.
\n* push - team members can pull and push, but not administer this repository.
\n* admin - team members can pull, push and administer this repository.
\n* maintain - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations.
\n* triage - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations.

\n

If no permission is specified, the team's permission attribute will be used to determine what permission to grant the team on this repository.

", + "description": "

The permissions policy that controls the actions that are allowed to run. Can be one of: all, local_only, or selected.

", "enum": [ - "pull", - "push", - "admin", - "maintain", - "triage" + "all", + "local_only", + "selected" ], - "name": "permission", + "name": "allowed_actions", "in": "body", "rawType": "string", - "rawDescription": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n\\* `maintain` - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations. \n\\* `triage` - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", + "rawDescription": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", "childParamsGroups": [] } ] }, { - "verb": "delete", - "requestPath": "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", + "name": "owner", "in": "path", "required": true, "schema": { @@ -18315,15 +26099,66 @@ "descriptionHTML": "" }, { - "name": "team_slug", - "description": "team_slug parameter", + "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

team_slug parameter

" + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/permissions/selected-actions", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/permissions/selected-actions
" }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/permissions/selected-actions', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/permissions/selected-actions', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" + } + ], + "summary": "Get allowed actions for a repository", + "description": "Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/get-allowed-actions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-allowed-actions-for-a-repository" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "actions", + "subcategory": "permissions" + }, + "slug": "get-allowed-actions-for-a-repository", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"

\n

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"github_owned_allowed\": true,\n  \"verified_allowed\": false,\n  \"patterns_allowed\": [\n    \"monalisa/octocat@*\",\n    \"docker/*\"\n  ]\n}\n
" + } + ] + }, + { + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/permissions/selected-actions", + "serverUrl": "https://api.github.com", + "parameters": [ { "name": "owner", "in": "path", @@ -18346,35 +26181,95 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/repos/octocat/hello-world
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/permissions/selected-actions \\\n -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"],\"verified_allowed\":true}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/permissions/selected-actions \\\n  -d '{\"github_owned_allowed\":true,\"patterns_allowed\":[\"patterns_allowed\"],\"verified_allowed\":true}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}', {\n org: 'org',\n team_slug: 'team_slug',\n owner: 'octocat',\n repo: 'hello-world'\n})", - "html": "
await octokit.request('DELETE /orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}', {\n  org: 'org',\n  team_slug: 'team_slug',\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/actions/permissions/selected-actions', {\n owner: 'octocat',\n repo: 'hello-world',\n github_owned_allowed: true,\n patterns_allowed: [\n 'patterns_allowed'\n ],\n verified_allowed: true\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/actions/permissions/selected-actions', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  github_owned_allowed: true,\n  patterns_allowed: [\n    'patterns_allowed'\n  ],\n  verified_allowed: true\n})\n
" } ], - "summary": "Remove a repository from a team", - "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "summary": "Set allowed actions for a repository", + "description": "Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/set-allowed-actions-repository", "tags": [ - "teams" + "actions" ], - "operationId": "teams/remove-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#remove-a-repository-from-a-team" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-allowed-actions-for-a-repository" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "

Required. Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", + "name": "github_owned_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", + "childParamsGroups": [] + }, + "verified_allowed": { + "type": "boolean", + "description": "

Required. Whether actions in GitHub Marketplace from verified creators are allowed. Set to true to allow all GitHub Marketplace actions by verified creators.

", + "name": "verified_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators.", + "childParamsGroups": [] + }, + "patterns_allowed": { + "type": "array of strings", + "description": "

Required. Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", + "items": { + "type": "string" + }, + "name": "patterns_allowed", + "in": "body", + "rawType": "array", + "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "childParamsGroups": [] + } + }, + "required": [ + "github_owned_allowed", + "patterns_allowed", + "verified_allowed" + ] + }, + "examples": { + "selected_actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "previews": [], - "category": "teams", - "subcategory": null + "category": "actions", + "subcategory": "permissions" }, - "slug": "remove-a-repository-from-a-team", - "category": "teams", - "categoryLabel": "Teams", + "slug": "set-allowed-actions-for-a-repository", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "permissions", + "subcategoryLabel": "Permissions", "notes": [], "responses": [ { @@ -18383,16 +26278,47 @@ "description": "Default Response" } ], - "bodyParameters": [], - "descriptionHTML": "

If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.

\n

Note: You can also specify a team by org_id and team_id using the route DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}.

" + "descriptionHTML": "

Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for allowed_actions must be configured to selected. For more information, see \"Set GitHub Actions permissions for a repository.\"

\n

If the repository belongs to an organization or enterprise that has selected actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.

\n

To use the patterns_allowed setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the patterns_allowed setting only applies to public repositories.

\n

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the administration repository permission to use this API.

", + "bodyParameters": [ + { + "type": "boolean", + "description": "

Required. Whether GitHub-owned actions are allowed. For example, this includes the actions in the actions organization.

", + "name": "github_owned_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Required. Whether actions in GitHub Marketplace from verified creators are allowed. Set to true to allow all GitHub Marketplace actions by verified creators.

", + "name": "verified_allowed", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators.", + "childParamsGroups": [] + }, + { + "type": "array of strings", + "description": "

Required. Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, monalisa/octocat@*, monalisa/octocat@v2, monalisa/*.\"

", + "items": { + "type": "string" + }, + "name": "patterns_allowed", + "in": "body", + "rawType": "array", + "rawDescription": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "childParamsGroups": [] + } + ] }, { "verb": "get", - "requestPath": "/orgs/{org}/teams/{team_slug}/teams", + "requestPath": "/repos/{owner}/{repo}/actions/runners", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "org", + "name": "owner", "in": "path", "required": true, "schema": { @@ -18401,14 +26327,13 @@ "descriptionHTML": "" }, { - "name": "team_slug", - "description": "team_slug parameter", + "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, - "descriptionHTML": "

team_slug parameter

" + "descriptionHTML": "" }, { "name": "per_page", @@ -18434,843 +26359,738 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/orgs/ORG/teams/TEAM_SLUG/teams", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/orgs/ORG/teams/TEAM_SLUG/teams
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runners", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runners
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /orgs/{org}/teams/{team_slug}/teams', {\n org: 'org',\n team_slug: 'team_slug'\n})", - "html": "
await octokit.request('GET /orgs/{org}/teams/{team_slug}/teams', {\n  org: 'org',\n  team_slug: 'team_slug'\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/runners', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/runners', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" } ], - "summary": "List child teams", - "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", + "summary": "List self-hosted runners for a repository", + "description": "Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint.", "tags": [ - "teams" + "actions" ], - "operationId": "teams/list-child-in-org", + "operationId": "actions/list-self-hosted-runners-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#list-child-teams" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-self-hosted-runners-for-a-repository" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "category": "teams", - "subcategory": null + "category": "actions", + "subcategory": "self-hosted-runners" }, - "slug": "list-child-teams", - "category": "teams", - "categoryLabel": "Teams", + "slug": "list-self-hosted-runners-for-a-repository", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "self-hosted-runners", + "subcategoryLabel": "Self hosted runners", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Lists the child teams of the team specified by {team_slug}.

\n

Note: You can also specify a team by org_id and team_id using the route GET /organizations/{org_id}/team/{team_id}/teams.

", + "descriptionHTML": "

Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the repo scope to use this endpoint.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", - "description": "Response if child teams exist", - "payload": "
[\n  {\n    \"id\": 2,\n    \"node_id\": \"MDQ6VGVhbTI=\",\n    \"url\": \"https://api.github.com/teams/2\",\n    \"name\": \"Original Roster\",\n    \"slug\": \"original-roster\",\n    \"description\": \"Started it all.\",\n    \"privacy\": \"closed\",\n    \"permission\": \"admin\",\n    \"members_url\": \"https://api.github.com/teams/2/members{/member}\",\n    \"repositories_url\": \"https://api.github.com/teams/2/repos\",\n    \"parent\": {\n      \"id\": 1,\n      \"node_id\": \"MDQ6VGVhbTE=\",\n      \"url\": \"https://api.github.com/teams/1\",\n      \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n      \"name\": \"Justice League\",\n      \"slug\": \"justice-league\",\n      \"description\": \"A great team.\",\n      \"privacy\": \"closed\",\n      \"permission\": \"admin\",\n      \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n      \"repositories_url\": \"https://api.github.com/teams/1/repos\"\n    },\n    \"html_url\": \"https://github.com/orgs/rails/teams/core\"\n  }\n]\n
" + "description": "Default response", + "payload": "
{\n  \"total_count\": 2,\n  \"runners\": [\n    {\n      \"id\": 23,\n      \"name\": \"linux_runner\",\n      \"os\": \"linux\",\n      \"status\": \"online\",\n      \"busy\": true,\n      \"labels\": [\n        {\n          \"id\": 5,\n          \"name\": \"self-hosted\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 7,\n          \"name\": \"X64\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 11,\n          \"name\": \"Linux\",\n          \"type\": \"read-only\"\n        }\n      ]\n    },\n    {\n      \"id\": 24,\n      \"name\": \"mac_runner\",\n      \"os\": \"macos\",\n      \"status\": \"offline\",\n      \"busy\": false,\n      \"labels\": [\n        {\n          \"id\": 5,\n          \"name\": \"self-hosted\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 7,\n          \"name\": \"X64\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 20,\n          \"name\": \"macOS\",\n          \"type\": \"read-only\"\n        },\n        {\n          \"id\": 21,\n          \"name\": \"no-gpu\",\n          \"type\": \"custom\"\n        }\n      ]\n    }\n  ]\n}\n
" } ] }, { - "verb": "get", - "requestPath": "/projects/columns/cards/{card_id}", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/actions/runners/{runner_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "card_id", - "description": "card_id parameter", + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "

card_id parameter

" + "descriptionHTML": "

Unique identifier of the self-hosted runner.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runners/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runners/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /projects/columns/cards/{card_id}', {\n card_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('GET /projects/columns/cards/{card_id}', {\n  card_id: 42,\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n runner_id: 42\n})", + "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/actions/runners/{runner_id}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  runner_id: 42\n})\n
" } ], - "summary": "Get a project card", - "description": "", + "summary": "Delete a self-hosted runner from a repository", + "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo`\nscope to use this endpoint.", "tags": [ - "projects" + "actions" ], - "operationId": "projects/get-card", + "operationId": "actions/delete-self-hosted-runner-from-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#get-a-project-card" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "projects", - "subcategory": "cards" + "previews": [], + "category": "actions", + "subcategory": "self-hosted-runners" }, - "slug": "get-a-project-card", - "category": "projects", - "categoryLabel": "Projects", - "subcategory": "cards", - "subcategoryLabel": "Cards", + "slug": "delete-a-self-hosted-runner-from-a-repository", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "self-hosted-runners", + "subcategoryLabel": "Self hosted runners", "notes": [], - "bodyParameters": [], - "descriptionHTML": "", "responses": [ { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Default response", - "payload": "
{\n  \"url\": \"https://api.github.com/projects/columns/cards/1478\",\n  \"id\": 1478,\n  \"node_id\": \"MDExOlByb2plY3RDYXJkMTQ3OA==\",\n  \"note\": \"Add payload for delete Project column\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2016-09-05T14:21:06Z\",\n  \"updated_at\": \"2016-09-05T14:20:22Z\",\n  \"archived\": false,\n  \"column_url\": \"https://api.github.com/projects/columns/367\",\n  \"content_url\": \"https://api.github.com/repos/api-playground/projects-test/issues/3\",\n  \"project_url\": \"https://api.github.com/projects/120\"\n}\n
" + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.

\n

You must authenticate using an access token with the repo\nscope to use this endpoint.

" + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runs", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" }, { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" }, { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" + "name": "actor", + "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.

" }, { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" + "name": "branch", + "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

Returns workflow runs associated with a branch. Use the name of the branch of the push.

" }, { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - } - ] - }, - { - "verb": "patch", - "requestPath": "/projects/columns/cards/{card_id}", - "serverUrl": "https://api.github.com", - "parameters": [ + "name": "event", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see \"Events that trigger workflows.\"

" + }, { - "name": "card_id", - "description": "card_id parameter", - "in": "path", - "required": true, + "name": "status", + "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/github-ae@latest/rest/reference/checks#create-a-check-run).\"", + "in": "query", + "required": false, "schema": { - "type": "integer" + "type": "string", + "enum": [ + "completed", + "action_required", + "cancelled", + "failure", + "neutral", + "skipped", + "stale", + "success", + "timed_out", + "in_progress", + "queued", + "requested", + "waiting" + ] }, - "descriptionHTML": "

card_id parameter

" + "descriptionHTML": "

Returns workflow runs with the check run status or conclusion that you specify. For example, a conclusion can be success or a status can be in_progress. Only GitHub can set a status of waiting or requested. For a list of the possible status and conclusion options, see \"Create a check run.\"

" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42 \\\n -d '{\"note\":\"note\"}'", - "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42 \\\n  -d '{\"note\":\"note\"}'
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs
" }, { "lang": "JavaScript", - "source": "await octokit.request('PATCH /projects/columns/cards/{card_id}', {\n card_id: 42,\n note: 'note',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('PATCH /projects/columns/cards/{card_id}', {\n  card_id: 42,\n  note: 'note',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/runs', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/runs', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" } ], - "summary": "Update an existing project card", - "description": "", + "summary": "List workflow runs for a repository", + "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ - "projects" + "actions" ], - "operationId": "projects/update-card", + "operationId": "actions/list-workflow-runs-for-repo", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#update-a-project-card" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "note": { - "description": "

The project card's note

", - "example": "Update all gems", - "type": "string or null", - "nullable": true, - "name": "note", - "in": "body", - "rawType": "string", - "rawDescription": "The project card's note", - "childParamsGroups": [] - }, - "archived": { - "description": "

Whether or not the card is archived

", - "example": false, - "type": "boolean", - "name": "archived", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether or not the card is archived", - "childParamsGroups": [] - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "projects", - "subcategory": "cards" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-workflow-runs-for-a-repository" }, - "slug": "update-an-existing-project-card", - "category": "projects", - "categoryLabel": "Projects", - "subcategory": "cards", - "subcategoryLabel": "Cards", - "notes": [], - "descriptionHTML": "", - "bodyParameters": [ - { - "description": "

The project card's note

", - "example": "Update all gems", - "type": "string or null", - "nullable": true, - "name": "note", - "in": "body", - "rawType": "string", - "rawDescription": "The project card's note", - "childParamsGroups": [] - }, - { - "description": "

Whether or not the card is archived

", - "example": false, - "type": "boolean", - "name": "archived", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether or not the card is archived", - "childParamsGroups": [] - } - ], + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "slug": "list-workflow-runs-for-a-repository", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

\n

Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"url\": \"https://api.github.com/projects/columns/cards/1478\",\n  \"id\": 1478,\n  \"node_id\": \"MDExOlByb2plY3RDYXJkMTQ3OA==\",\n  \"note\": \"Add payload for delete Project column\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2016-09-05T14:21:06Z\",\n  \"updated_at\": \"2016-09-05T14:20:22Z\",\n  \"archived\": false,\n  \"column_url\": \"https://api.github.com/projects/columns/367\",\n  \"content_url\": \"https://api.github.com/repos/api-playground/projects-test/issues/3\",\n  \"project_url\": \"https://api.github.com/projects/120\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "payload": "
{\n  \"total_count\": 1,\n  \"workflow_runs\": [\n    {\n      \"id\": 30433642,\n      \"name\": \"Build\",\n      \"node_id\": \"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\n      \"head_branch\": \"master\",\n      \"head_sha\": \"acb5820ced9479c074f688cc328bf03f341a511d\",\n      \"run_number\": 562,\n      \"event\": \"push\",\n      \"status\": \"queued\",\n      \"conclusion\": null,\n      \"workflow_id\": 159038,\n      \"url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\n      \"html_url\": \"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\n      \"pull_requests\": [],\n      \"created_at\": \"2020-01-22T19:33:08Z\",\n      \"updated_at\": \"2020-01-22T19:33:08Z\",\n      \"jobs_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\n      \"logs_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\n      \"check_suite_url\": \"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\n      \"artifacts_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\n      \"cancel_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\n      \"rerun_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\n      \"workflow_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\n      \"head_commit\": {\n        \"id\": \"acb5820ced9479c074f688cc328bf03f341a511d\",\n        \"tree_id\": \"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\n        \"message\": \"Create linter.yaml\",\n        \"timestamp\": \"2020-01-22T19:33:05Z\",\n        \"author\": {\n          \"name\": \"Octo Cat\",\n          \"email\": \"octocat@github.com\"\n        },\n        \"committer\": {\n          \"name\": \"GitHub\",\n          \"email\": \"noreply@github.com\"\n        }\n      },\n      \"repository\": {\n        \"id\": 1296269,\n        \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n        \"name\": \"Hello-World\",\n        \"full_name\": \"octocat/Hello-World\",\n        \"owner\": {\n          \"login\": \"octocat\",\n          \"id\": 1,\n          \"node_id\": \"MDQ6VXNlcjE=\",\n          \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n          \"gravatar_id\": \"\",\n          \"url\": \"https://api.github.com/users/octocat\",\n          \"html_url\": \"https://github.com/octocat\",\n          \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n          \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n          \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n          \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n          \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n          \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n          \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n          \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n          \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n          \"type\": \"User\",\n          \"site_admin\": false\n        },\n        \"private\": false,\n        \"html_url\": \"https://github.com/octocat/Hello-World\",\n        \"description\": \"This your first repo!\",\n        \"fork\": false,\n        \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n        \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n        \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n        \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n        \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n        \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n        \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n        \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n        \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n        \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n        \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n        \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n        \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n        \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n        \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n        \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n        \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n        \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n        \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n        \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n        \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n        \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n        \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n        \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n        \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n        \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n        \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n        \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n        \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n        \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n        \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n        \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n        \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n        \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n        \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n        \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n        \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n        \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n        \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n      },\n      \"head_repository\": {\n        \"id\": 217723378,\n        \"node_id\": \"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\n        \"name\": \"octo-repo\",\n        \"full_name\": \"octo-org/octo-repo\",\n        \"private\": true,\n        \"owner\": {\n          \"login\": \"octocat\",\n          \"id\": 1,\n          \"node_id\": \"MDQ6VXNlcjE=\",\n          \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n          \"gravatar_id\": \"\",\n          \"url\": \"https://api.github.com/users/octocat\",\n          \"html_url\": \"https://github.com/octocat\",\n          \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n          \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n          \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n          \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n          \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n          \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n          \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n          \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n          \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n          \"type\": \"User\",\n          \"site_admin\": false\n        },\n        \"html_url\": \"https://github.com/octo-org/octo-repo\",\n        \"description\": null,\n        \"fork\": false,\n        \"url\": \"https://api.github.com/repos/octo-org/octo-repo\",\n        \"forks_url\": \"https://api.github.com/repos/octo-org/octo-repo/forks\",\n        \"keys_url\": \"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\n        \"collaborators_url\": \"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\n        \"teams_url\": \"https://api.github.com/repos/octo-org/octo-repo/teams\",\n        \"hooks_url\": \"https://api.github.com/repos/octo-org/octo-repo/hooks\",\n        \"issue_events_url\": \"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\n        \"events_url\": \"https://api.github.com/repos/octo-org/octo-repo/events\",\n        \"assignees_url\": \"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\n        \"branches_url\": \"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\n        \"tags_url\": \"https://api.github.com/repos/octo-org/octo-repo/tags\",\n        \"blobs_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\n        \"git_tags_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\n        \"git_refs_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\n        \"trees_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\n        \"statuses_url\": \"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\n        \"languages_url\": \"https://api.github.com/repos/octo-org/octo-repo/languages\",\n        \"stargazers_url\": \"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\n        \"contributors_url\": \"https://api.github.com/repos/octo-org/octo-repo/contributors\",\n        \"subscribers_url\": \"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\n        \"subscription_url\": \"https://api.github.com/repos/octo-org/octo-repo/subscription\",\n        \"commits_url\": \"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\n        \"git_commits_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\n        \"comments_url\": \"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\n        \"issue_comment_url\": \"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\n        \"contents_url\": \"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\n        \"compare_url\": \"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\n        \"merges_url\": \"https://api.github.com/repos/octo-org/octo-repo/merges\",\n        \"archive_url\": \"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\n        \"downloads_url\": \"https://api.github.com/repos/octo-org/octo-repo/downloads\",\n        \"issues_url\": \"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\n        \"pulls_url\": \"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\n        \"milestones_url\": \"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\n        \"notifications_url\": \"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\n        \"labels_url\": \"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\n        \"releases_url\": \"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\n        \"deployments_url\": \"https://api.github.com/repos/octo-org/octo-repo/deployments\"\n      }\n    }\n  ]\n}\n
" } ] }, { - "verb": "delete", - "requestPath": "/projects/columns/cards/{card_id}", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "card_id", - "description": "card_id parameter", + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "

card_id parameter

" + "descriptionHTML": "

The id of the workflow run

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /projects/columns/cards/{card_id}', {\n card_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('DELETE /projects/columns/cards/{card_id}', {\n  card_id: 42,\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
" } ], - "summary": "Delete a project card", - "description": "", + "summary": "Get a workflow run", + "description": "Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ - "projects" + "actions" ], - "operationId": "projects/delete-card", + "operationId": "actions/get-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#delete-a-project-card" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-workflow-run" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "projects", - "subcategory": "cards" + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" }, - "slug": "delete-a-project-card", - "category": "projects", - "categoryLabel": "Projects", - "subcategory": "cards", - "subcategoryLabel": "Cards", + "slug": "get-a-workflow-run", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

", "responses": [ { - "httpStatusCode": "204", - "httpStatusMessage": "No Content", - "description": "Default Response" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"id\": 30433642,\n  \"name\": \"Build\",\n  \"node_id\": \"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\n  \"head_branch\": \"master\",\n  \"head_sha\": \"acb5820ced9479c074f688cc328bf03f341a511d\",\n  \"run_number\": 562,\n  \"event\": \"push\",\n  \"status\": \"queued\",\n  \"conclusion\": null,\n  \"workflow_id\": 159038,\n  \"url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\n  \"html_url\": \"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\n  \"pull_requests\": [],\n  \"created_at\": \"2020-01-22T19:33:08Z\",\n  \"updated_at\": \"2020-01-22T19:33:08Z\",\n  \"jobs_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\n  \"logs_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\n  \"check_suite_url\": \"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\n  \"artifacts_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\n  \"cancel_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\n  \"rerun_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\n  \"workflow_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\n  \"head_commit\": {\n    \"id\": \"acb5820ced9479c074f688cc328bf03f341a511d\",\n    \"tree_id\": \"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\n    \"message\": \"Create linter.yaml\",\n    \"timestamp\": \"2020-01-22T19:33:05Z\",\n    \"author\": {\n      \"name\": \"Octo Cat\",\n      \"email\": \"octocat@github.com\"\n    },\n    \"committer\": {\n      \"name\": \"GitHub\",\n      \"email\": \"noreply@github.com\"\n    }\n  },\n  \"repository\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n  },\n  \"head_repository\": {\n    \"id\": 217723378,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\n    \"name\": \"octo-repo\",\n    \"full_name\": \"octo-org/octo-repo\",\n    \"private\": true,\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"html_url\": \"https://github.com/octo-org/octo-repo\",\n    \"description\": null,\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octo-org/octo-repo\",\n    \"forks_url\": \"https://api.github.com/repos/octo-org/octo-repo/forks\",\n    \"keys_url\": \"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\n    \"teams_url\": \"https://api.github.com/repos/octo-org/octo-repo/teams\",\n    \"hooks_url\": \"https://api.github.com/repos/octo-org/octo-repo/hooks\",\n    \"issue_events_url\": \"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\n    \"events_url\": \"https://api.github.com/repos/octo-org/octo-repo/events\",\n    \"assignees_url\": \"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\n    \"branches_url\": \"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\n    \"tags_url\": \"https://api.github.com/repos/octo-org/octo-repo/tags\",\n    \"blobs_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\n    \"trees_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\n    \"statuses_url\": \"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\n    \"languages_url\": \"https://api.github.com/repos/octo-org/octo-repo/languages\",\n    \"stargazers_url\": \"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\n    \"contributors_url\": \"https://api.github.com/repos/octo-org/octo-repo/contributors\",\n    \"subscribers_url\": \"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octo-org/octo-repo/subscription\",\n    \"commits_url\": \"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\n    \"git_commits_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\n    \"comments_url\": \"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\n    \"contents_url\": \"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\n    \"compare_url\": \"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\n    \"merges_url\": \"https://api.github.com/repos/octo-org/octo-repo/merges\",\n    \"archive_url\": \"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\n    \"downloads_url\": \"https://api.github.com/repos/octo-org/octo-repo/downloads\",\n    \"issues_url\": \"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\n    \"pulls_url\": \"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\n    \"milestones_url\": \"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\n    \"labels_url\": \"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\n    \"releases_url\": \"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\n    \"deployments_url\": \"https://api.github.com/repos/octo-org/octo-repo/deployments\"\n  }\n}\n
" } - ], - "bodyParameters": [], - "descriptionHTML": "" + ] }, { - "verb": "post", - "requestPath": "/projects/columns/cards/{card_id}/moves", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "card_id", - "description": "card_id parameter", + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "

card_id parameter

" + "descriptionHTML": "

The id of the workflow run

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/cards/42/moves \\\n -d '{\"position\":\"position\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/cards/42/moves \\\n  -d '{\"position\":\"position\"}'
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /projects/columns/cards/{card_id}/moves', {\n card_id: 42,\n position: 'position',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('POST /projects/columns/cards/{card_id}/moves', {\n  card_id: 42,\n  position: 'position',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/actions/runs/{run_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/actions/runs/{run_id}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
" } ], - "summary": "Move a project card", - "description": "", + "summary": "Delete a workflow run", + "description": "Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is\nprivate you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use\nthis endpoint.", + "operationId": "actions/delete-workflow-run", "tags": [ - "projects" + "actions" ], - "operationId": "projects/move-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#move-a-project-card" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "

Required. The position of the card in a column

", - "example": "bottom", - "type": "string", - "pattern": "^(?:top|bottom|after:\\d+)$", - "name": "position", - "in": "body", - "rawType": "string", - "rawDescription": "The position of the card in a column", - "childParamsGroups": [] - }, - "column_id": { - "description": "

The unique identifier of the column the card should be moved to

", - "example": 42, - "type": "integer", - "name": "column_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the column the card should be moved to", - "childParamsGroups": [] - } - }, - "required": [ - "position" - ], - "type": "object" - } - } - } + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-a-workflow-run" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "projects", - "subcategory": "cards" + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" }, - "slug": "move-a-project-card", - "category": "projects", - "categoryLabel": "Projects", - "subcategory": "cards", - "subcategoryLabel": "Cards", + "slug": "delete-a-workflow-run", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", "notes": [], "responses": [ { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" } ], - "descriptionHTML": "", - "bodyParameters": [ - { - "description": "

Required. The position of the card in a column

", - "example": "bottom", - "type": "string", - "pattern": "^(?:top|bottom|after:\\d+)$", - "name": "position", - "in": "body", - "rawType": "string", - "rawDescription": "The position of the card in a column", - "childParamsGroups": [] - }, - { - "description": "

The unique identifier of the column the card should be moved to

", - "example": 42, - "type": "integer", - "name": "column_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The unique identifier of the column the card should be moved to", - "childParamsGroups": [] - } - ] + "bodyParameters": [], + "descriptionHTML": "

Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is\nprivate you must use an access token with the repo scope. GitHub Apps must have the actions:write permission to use\nthis endpoint.

" }, { "verb": "get", - "requestPath": "/projects/columns/{column_id}", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "column_id", - "description": "column_id parameter", + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "

column_id parameter

" + "descriptionHTML": "

The id of the workflow run

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/approvals", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/approvals
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /projects/columns/{column_id}', {\n column_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('GET /projects/columns/{column_id}', {\n  column_id: 42,\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/approvals', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
" } ], - "summary": "Get a project column", - "description": "", + "summary": "Get the review history for a workflow run", + "description": "Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ - "projects" + "actions" ], - "operationId": "projects/get-column", + "operationId": "actions/get-reviews-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#get-a-project-column" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-the-review-history-for-a-workflow-run" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "projects", - "subcategory": "columns" + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" }, - "slug": "get-a-project-column", - "category": "projects", - "categoryLabel": "Projects", - "subcategory": "columns", - "subcategoryLabel": "Columns", + "slug": "get-the-review-history-for-a-workflow-run", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", "notes": [], "bodyParameters": [], - "descriptionHTML": "", + "descriptionHTML": "

Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"url\": \"https://api.github.com/projects/columns/367\",\n  \"project_url\": \"https://api.github.com/projects/120\",\n  \"cards_url\": \"https://api.github.com/projects/columns/367/cards\",\n  \"id\": 367,\n  \"node_id\": \"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\n  \"name\": \"To Do\",\n  \"created_at\": \"2016-09-05T14:18:44Z\",\n  \"updated_at\": \"2016-09-05T14:22:28Z\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "payload": "
[\n  {\n    \"state\": \"approved\",\n    \"comment\": \"Ship it!\",\n    \"environments\": [\n      {\n        \"id\": 161088068,\n        \"node_id\": \"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\n        \"name\": \"staging\",\n        \"url\": \"https://api.github.com/repos/github/hello-world/environments/staging\",\n        \"html_url\": \"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\n        \"created_at\": \"2020-11-23T22:00:40Z\",\n        \"updated_at\": \"2020-11-23T22:00:40Z\"\n      }\n    ],\n    \"user\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    }\n  }\n]\n
" } ] }, { - "verb": "patch", - "requestPath": "/projects/columns/{column_id}", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "column_id", - "description": "column_id parameter", + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "

column_id parameter

" + "descriptionHTML": "

The id of the workflow run

" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42 \\\n  -d '{\"name\":\"name\"}'
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/artifacts", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/artifacts
" }, { "lang": "JavaScript", - "source": "await octokit.request('PATCH /projects/columns/{column_id}', {\n column_id: 42,\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('PATCH /projects/columns/{column_id}', {\n  column_id: 42,\n  name: 'name',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/artifacts', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
" } ], - "summary": "Update an existing project column", - "description": "", + "summary": "List workflow run artifacts", + "description": "Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ - "projects" + "actions" ], - "operationId": "projects/update-column", + "operationId": "actions/list-workflow-run-artifacts", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#update-a-project-column" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "

Required. Name of the project column

", - "example": "Remaining tasks", - "type": "string", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "Name of the project column", - "childParamsGroups": [] - } - }, - "required": [ - "name" - ], - "type": "object" - } - } - } + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-workflow-run-artifacts" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "projects", - "subcategory": "columns" + "previews": [], + "category": "actions", + "subcategory": "artifacts" }, - "slug": "update-an-existing-project-column", - "category": "projects", - "categoryLabel": "Projects", - "subcategory": "columns", - "subcategoryLabel": "Columns", + "slug": "list-workflow-run-artifacts", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "artifacts", + "subcategoryLabel": "Artifacts", "notes": [], - "descriptionHTML": "", - "bodyParameters": [ - { - "description": "

Required. Name of the project column

", - "example": "Remaining tasks", - "type": "string", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "Name of the project column", - "childParamsGroups": [] - } - ], + "bodyParameters": [], + "descriptionHTML": "

Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"url\": \"https://api.github.com/projects/columns/367\",\n  \"project_url\": \"https://api.github.com/projects/120\",\n  \"cards_url\": \"https://api.github.com/projects/columns/367/cards\",\n  \"id\": 367,\n  \"node_id\": \"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\n  \"name\": \"To Do\",\n  \"created_at\": \"2016-09-05T14:18:44Z\",\n  \"updated_at\": \"2016-09-05T14:22:28Z\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" + "payload": "
{\n  \"total_count\": 2,\n  \"artifacts\": [\n    {\n      \"id\": 11,\n      \"node_id\": \"MDg6QXJ0aWZhY3QxMQ==\",\n      \"name\": \"Rails\",\n      \"size_in_bytes\": 556,\n      \"url\": \"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11\",\n      \"archive_download_url\": \"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip\",\n      \"expired\": false,\n      \"created_at\": \"2020-01-10T14:59:22Z\",\n      \"expires_at\": \"2020-03-21T14:59:22Z\",\n      \"updated_at\": \"2020-02-21T14:59:22Z\"\n    },\n    {\n      \"id\": 13,\n      \"node_id\": \"MDg6QXJ0aWZhY3QxMw==\",\n      \"name\": \"\",\n      \"size_in_bytes\": 453,\n      \"url\": \"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13\",\n      \"archive_download_url\": \"https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip\",\n      \"expired\": false,\n      \"created_at\": \"2020-01-10T14:59:22Z\",\n      \"expires_at\": \"2020-03-21T14:59:22Z\",\n      \"updated_at\": \"2020-02-21T14:59:22Z\"\n    }\n  ]\n}\n
" } ] }, { - "verb": "delete", - "requestPath": "/projects/columns/{column_id}", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "column_id", - "description": "column_id parameter", + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "

column_id parameter

" + "descriptionHTML": "

The id of the workflow run

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/cancel", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/cancel
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /projects/columns/{column_id}', {\n column_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('DELETE /projects/columns/{column_id}', {\n  column_id: 42,\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/actions/runs/{run_id}/cancel', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
" } ], - "summary": "Delete a project column", - "description": "", + "summary": "Cancel a workflow run", + "description": "Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", "tags": [ - "projects" + "actions" ], - "operationId": "projects/delete-column", + "operationId": "actions/cancel-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#delete-a-project-column" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#cancel-a-workflow-run" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "projects", - "subcategory": "columns" - }, - "slug": "delete-a-project-column", - "category": "projects", - "categoryLabel": "Projects", - "subcategory": "columns", - "subcategoryLabel": "Columns", - "notes": [], - "responses": [ - { - "httpStatusCode": "204", - "httpStatusMessage": "No Content", - "description": "Default Response" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "slug": "cancel-a-workflow-run", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", + "notes": [], + "responses": [ { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Response" } ], "bodyParameters": [], - "descriptionHTML": "" + "descriptionHTML": "

Cancels a workflow run using its id. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

" }, { "verb": "get", - "requestPath": "/projects/columns/{column_id}/cards", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "column_id", - "description": "column_id parameter", + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "

column_id parameter

" + "descriptionHTML": "

The id of the workflow run

" }, { - "name": "archived_state", - "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`.", + "name": "filter", + "description": "Filters jobs by their `completed_at` timestamp. Can be one of: \n\\* `latest`: Returns jobs from the most recent execution of the workflow run. \n\\* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run.", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "all", - "archived", - "not_archived" + "latest", + "all" ], - "default": "not_archived" + "default": "latest" }, - "descriptionHTML": "

Filters the project cards that are returned by the card's state. Can be one of all,archived, or not_archived.

" + "descriptionHTML": "

Filters jobs by their completed_at timestamp. Can be one of:
\n* latest: Returns jobs from the most recent execution of the workflow run.
\n* all: Returns all jobs for a workflow run, including from old executions of the workflow run.

" }, { "name": "per_page", @@ -19296,513 +27116,396 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/cards
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/jobs", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/jobs
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /projects/columns/{column_id}/cards', {\n column_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('GET /projects/columns/{column_id}/cards', {\n  column_id: 42,\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/jobs', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
" } ], - "summary": "List project cards", - "description": "", + "summary": "List jobs for a workflow run", + "description": "Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters).", "tags": [ - "projects" + "actions" ], - "operationId": "projects/list-cards", + "operationId": "actions/list-jobs-for-workflow-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#list-project-cards" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-jobs-for-a-workflow-run" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "projects", - "subcategory": "cards" + "previews": [], + "category": "actions", + "subcategory": "workflow-jobs" }, - "slug": "list-project-cards", - "category": "projects", - "categoryLabel": "Projects", - "subcategory": "cards", - "subcategoryLabel": "Cards", + "slug": "list-jobs-for-a-workflow-run", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-jobs", + "subcategoryLabel": "Workflow jobs", "notes": [], "bodyParameters": [], - "descriptionHTML": "", + "descriptionHTML": "

Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"url\": \"https://api.github.com/projects/columns/cards/1478\",\n    \"id\": 1478,\n    \"node_id\": \"MDExOlByb2plY3RDYXJkMTQ3OA==\",\n    \"note\": \"Add payload for delete Project column\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"created_at\": \"2016-09-05T14:21:06Z\",\n    \"updated_at\": \"2016-09-05T14:20:22Z\",\n    \"archived\": false,\n    \"column_url\": \"https://api.github.com/projects/columns/367\",\n    \"content_url\": \"https://api.github.com/repos/api-playground/projects-test/issues/3\",\n    \"project_url\": \"https://api.github.com/projects/120\"\n  }\n]\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" + "payload": "
{\n  \"total_count\": 1,\n  \"jobs\": [\n    {\n      \"id\": 399444496,\n      \"run_id\": 29679449,\n      \"run_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449\",\n      \"node_id\": \"MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==\",\n      \"head_sha\": \"f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0\",\n      \"url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496\",\n      \"html_url\": \"https://github.com/octo-org/octo-repo/runs/399444496\",\n      \"status\": \"completed\",\n      \"conclusion\": \"success\",\n      \"started_at\": \"2020-01-20T17:42:40Z\",\n      \"completed_at\": \"2020-01-20T17:44:39Z\",\n      \"name\": \"build\",\n      \"steps\": [\n        {\n          \"name\": \"Set up job\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 1,\n          \"started_at\": \"2020-01-20T09:42:40.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:41.000-08:00\"\n        },\n        {\n          \"name\": \"Run actions/checkout@v2\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 2,\n          \"started_at\": \"2020-01-20T09:42:41.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:45.000-08:00\"\n        },\n        {\n          \"name\": \"Set up Ruby\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 3,\n          \"started_at\": \"2020-01-20T09:42:45.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:45.000-08:00\"\n        },\n        {\n          \"name\": \"Run actions/cache@v2\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 4,\n          \"started_at\": \"2020-01-20T09:42:45.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:48.000-08:00\"\n        },\n        {\n          \"name\": \"Install Bundler\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 5,\n          \"started_at\": \"2020-01-20T09:42:48.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:52.000-08:00\"\n        },\n        {\n          \"name\": \"Install Gems\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 6,\n          \"started_at\": \"2020-01-20T09:42:52.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:53.000-08:00\"\n        },\n        {\n          \"name\": \"Run Tests\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 7,\n          \"started_at\": \"2020-01-20T09:42:53.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:42:59.000-08:00\"\n        },\n        {\n          \"name\": \"Deploy to Heroku\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 8,\n          \"started_at\": \"2020-01-20T09:42:59.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:44:39.000-08:00\"\n        },\n        {\n          \"name\": \"Post actions/cache@v2\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 16,\n          \"started_at\": \"2020-01-20T09:44:39.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:44:39.000-08:00\"\n        },\n        {\n          \"name\": \"Complete job\",\n          \"status\": \"completed\",\n          \"conclusion\": \"success\",\n          \"number\": 17,\n          \"started_at\": \"2020-01-20T09:44:39.000-08:00\",\n          \"completed_at\": \"2020-01-20T09:44:39.000-08:00\"\n        }\n      ],\n      \"check_run_url\": \"https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496\"\n    }\n  ]\n}\n
" } ] }, { - "verb": "post", - "requestPath": "/projects/columns/{column_id}/cards", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "column_id", - "description": "column_id parameter", + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "

column_id parameter

" + "descriptionHTML": "

The id of the workflow run

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/cards \\\n -d '{\"note\":\"note\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/cards \\\n  -d '{\"note\":\"note\"}'
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/logs", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/logs
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /projects/columns/{column_id}/cards', {\n column_id: 42,\n note: 'note',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('POST /projects/columns/{column_id}/cards', {\n  column_id: 42,\n  note: 'note',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/logs', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
" } ], - "summary": "Create a project card", - "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests)\" endpoint.", + "summary": "Download workflow run logs", + "description": "Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\n`Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use\nthis endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have\nthe `actions:read` permission to use this endpoint.", "tags": [ - "projects" + "actions" ], - "operationId": "projects/create-card", + "operationId": "actions/download-workflow-run-logs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#create-a-project-card" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "note": { - "description": "The project card's note", - "example": "Update all gems", - "type": "string", - "nullable": true - } - }, - "required": [ - "note" - ] - }, - { - "type": "object", - "properties": { - "content_id": { - "description": "The unique identifier of the content associated with the card", - "example": 42, - "type": "integer" - }, - "content_type": { - "description": "The piece of content associated with the card", - "example": "PullRequest", - "type": "string" - } - }, - "required": [ - "content_id", - "content_type" - ] - } - ] - } - } - } + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#download-workflow-run-logs" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "projects", - "subcategory": "cards" + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" }, - "slug": "create-a-project-card", - "category": "projects", - "categoryLabel": "Projects", - "subcategory": "cards", - "subcategoryLabel": "Cards", + "slug": "download-workflow-run-logs", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Note: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the pull_request key.

\n

Be aware that the id of a pull request returned from \"Issues\" endpoints will be an issue id. To find out the pull request id, use the \"List pull requests\" endpoint.

", "responses": [ { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Default response", - "payload": "
{\n  \"url\": \"https://api.github.com/projects/columns/cards/1478\",\n  \"id\": 1478,\n  \"node_id\": \"MDExOlByb2plY3RDYXJkMTQ3OA==\",\n  \"note\": \"Add payload for delete Project column\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2016-09-05T14:21:06Z\",\n  \"updated_at\": \"2016-09-05T14:20:22Z\",\n  \"archived\": false,\n  \"column_url\": \"https://api.github.com/projects/columns/367\",\n  \"content_url\": \"https://api.github.com/repos/api-playground/projects-test/issues/3\",\n  \"project_url\": \"https://api.github.com/projects/120\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - }, - { - "httpStatusCode": "503", - "httpStatusMessage": "Service Unavailable", - "description": "Service unavailable" + "httpStatusCode": "302", + "httpStatusMessage": "Found", + "description": "Response" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\nLocation: in the response header to find the URL for the download. Anyone with read access to the repository can use\nthis endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have\nthe actions:read permission to use this endpoint.

" }, { - "verb": "post", - "requestPath": "/projects/columns/{column_id}/moves", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/logs", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "column_id", - "description": "column_id parameter", + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "

column_id parameter

" + "descriptionHTML": "

The id of the workflow run

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/columns/42/moves \\\n -d '{\"position\":\"position\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/columns/42/moves \\\n  -d '{\"position\":\"position\"}'
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/logs", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/logs
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /projects/columns/{column_id}/moves', {\n column_id: 42,\n position: 'position',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('POST /projects/columns/{column_id}/moves', {\n  column_id: 42,\n  position: 'position',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/actions/runs/{run_id}/logs', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
" } ], - "summary": "Move a project column", - "description": "", + "summary": "Delete workflow run logs", + "description": "Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", "tags": [ - "projects" + "actions" ], - "operationId": "projects/move-column", + "operationId": "actions/delete-workflow-run-logs", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#move-a-project-column" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "

Required. The position of the column in a project

", - "example": "last", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$", - "name": "position", - "in": "body", - "rawType": "string", - "rawDescription": "The position of the column in a project", - "childParamsGroups": [] - } - }, - "required": [ - "position" - ], - "type": "object" - } - } - } + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-workflow-run-logs" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "projects", - "subcategory": "columns" + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" }, - "slug": "move-a-project-column", - "category": "projects", - "categoryLabel": "Projects", - "subcategory": "columns", - "subcategoryLabel": "Columns", + "slug": "delete-workflow-run-logs", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", "notes": [], "responses": [ { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" } ], - "descriptionHTML": "", - "bodyParameters": [ - { - "description": "

Required. The position of the column in a project

", - "example": "last", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$", - "name": "position", - "in": "body", - "rawType": "string", - "rawDescription": "The position of the column in a project", - "childParamsGroups": [] - } - ] + "bodyParameters": [], + "descriptionHTML": "

Deletes all logs for a workflow run. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

" }, { "verb": "get", - "requestPath": "/projects/{project_id}", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "project_id", + "name": "owner", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" }, "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

The id of the workflow run

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/pending_deployments", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/pending_deployments
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /projects/{project_id}', {\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('GET /projects/{project_id}', {\n  project_id: 42,\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
" } ], - "summary": "Get a project", - "description": "Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "summary": "Get pending deployments for a workflow run", + "description": "Get all deployment environments for a workflow run that are waiting for protection rules to pass.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ - "projects" + "actions" ], - "operationId": "projects/get", + "operationId": "actions/get-pending-deployments-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects/#get-a-project" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-pending-deployments-for-a-workflow-run" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "projects", - "subcategory": null + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" }, - "slug": "get-a-project", - "category": "projects", - "categoryLabel": "Projects", + "slug": "get-pending-deployments-for-a-workflow-run", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Gets a project by its id. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

", + "descriptionHTML": "

Get all deployment environments for a workflow run that are waiting for protection rules to pass.

\n

Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"owner_url\": \"https://api.github.com/repos/api-playground/projects-test\",\n  \"url\": \"https://api.github.com/projects/1002604\",\n  \"html_url\": \"https://github.com/api-playground/projects-test/projects/1\",\n  \"columns_url\": \"https://api.github.com/projects/1002604/columns\",\n  \"id\": 1002604,\n  \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDQ=\",\n  \"name\": \"Projects Documentation\",\n  \"body\": \"Developer documentation project for the developer site.\",\n  \"number\": 1,\n  \"state\": \"open\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2011-04-10T20:09:31Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" + "payload": "
[\n  {\n    \"environment\": {\n      \"id\": 161088068,\n      \"node_id\": \"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\n      \"name\": \"staging\",\n      \"url\": \"https://api.github.com/repos/github/hello-world/environments/staging\",\n      \"html_url\": \"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\"\n    },\n    \"wait_timer\": 30,\n    \"wait_timer_started_at\": \"2020-11-23T22:00:40Z\",\n    \"current_user_can_approve\": true,\n    \"reviewers\": [\n      {\n        \"type\": \"User\",\n        \"reviewer\": {\n          \"login\": \"octocat\",\n          \"id\": 1,\n          \"node_id\": \"MDQ6VXNlcjE=\",\n          \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n          \"gravatar_id\": \"\",\n          \"url\": \"https://api.github.com/users/octocat\",\n          \"html_url\": \"https://github.com/octocat\",\n          \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n          \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n          \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n          \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n          \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n          \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n          \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n          \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n          \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n          \"type\": \"User\",\n          \"site_admin\": false\n        }\n      },\n      {\n        \"type\": \"Team\",\n        \"reviewer\": {\n          \"id\": 1,\n          \"node_id\": \"MDQ6VGVhbTE=\",\n          \"url\": \"https://api.github.com/teams/1\",\n          \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n          \"name\": \"Justice League\",\n          \"slug\": \"justice-league\",\n          \"description\": \"A great team.\",\n          \"privacy\": \"closed\",\n          \"permission\": \"admin\",\n          \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n          \"repositories_url\": \"https://api.github.com/teams/1/repos\"\n        }\n      }\n    ]\n  }\n]\n
" } ] }, { - "verb": "patch", - "requestPath": "/projects/{project_id}", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "project_id", + "name": "owner", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" }, "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

The id of the workflow run

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42 \\\n -d '{\"name\":\"name\"}'", - "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42 \\\n  -d '{\"name\":\"name\"}'
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/pending_deployments \\\n -d '{\"environment_ids\":[42],\"state\":\"state\",\"comment\":\"comment\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/pending_deployments \\\n  -d '{\"environment_ids\":[42],\"state\":\"state\",\"comment\":\"comment\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PATCH /projects/{project_id}', {\n project_id: 42,\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('PATCH /projects/{project_id}', {\n  project_id: 42,\n  name: 'name',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42,\n environment_ids: [\n 42\n ],\n state: 'state',\n comment: 'comment'\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42,\n  environment_ids: [\n    42\n  ],\n  state: 'state',\n  comment: 'comment'\n})\n
" } ], - "summary": "Update a project", - "description": "Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "operationId": "projects/update", + "summary": "Review pending deployments for a workflow run", + "description": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nAnyone with read access to the repository contents and deployments can use this endpoint.", "tags": [ - "projects" + "actions" ], + "operationId": "actions/review-pending-deployments-for-run", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects/#update-a-project" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#review-pending-deployments-for-a-workflow-run" }, "requestBody": { "content": { "application/json": { "schema": { + "type": "object", "properties": { - "name": { - "description": "

Name of the project

", - "example": "Week One Sprint", - "type": "string", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "Name of the project", - "childParamsGroups": [] - }, - "body": { - "description": "

Body of the project

", - "example": "This project represents the sprint of the first week in January", - "type": "string or null", - "nullable": true, - "name": "body", + "environment_ids": { + "type": "array of integers", + "description": "

Required. The list of environment ids to approve or reject

", + "example": [ + 161171787, + 161171795 + ], + "items": { + "type": "integer", + "example": 161171787 + }, + "name": "environment_ids", "in": "body", - "rawType": "string", - "rawDescription": "Body of the project", + "rawType": "array", + "rawDescription": "The list of environment ids to approve or reject", "childParamsGroups": [] }, "state": { - "description": "

State of the project; either 'open' or 'closed'

", - "example": "open", "type": "string", + "description": "

Required. Whether to approve or reject deployment to the specified environments. Must be one of: approved or rejected

", + "enum": [ + "approved", + "rejected" + ], + "example": "approved", "name": "state", "in": "body", "rawType": "string", - "rawDescription": "State of the project; either 'open' or 'closed'", + "rawDescription": "Whether to approve or reject deployment to the specified environments. Must be one of: `approved` or `rejected`", "childParamsGroups": [] }, - "organization_permission": { - "description": "

The baseline permission that all organization members have on this project

", + "comment": { "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ], - "name": "organization_permission", + "description": "

Required. A comment to accompany the deployment review

", + "example": "Ship it!", + "name": "comment", "in": "body", "rawType": "string", - "rawDescription": "The baseline permission that all organization members have on this project", - "childParamsGroups": [] - }, - "private": { - "description": "

Whether or not this project can be seen by everyone.

", - "type": "boolean", - "name": "private", - "in": "body", - "rawType": "boolean", - "rawDescription": "Whether or not this project can be seen by everyone.", + "rawDescription": "A comment to accompany the deployment review", "childParamsGroups": [] } }, - "type": "object" + "required": [ + "environment_ids", + "state", + "comment" + ] } } } @@ -19810,76 +27513,57 @@ "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "projects", - "subcategory": null + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" }, - "slug": "update-a-project", - "category": "projects", - "categoryLabel": "Projects", + "slug": "review-pending-deployments-for-a-workflow-run", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", "notes": [], - "descriptionHTML": "

Updates a project board's information. Returns a 404 Not Found status if projects are disabled. If you do not have sufficient privileges to perform this action, a 401 Unauthorized or 410 Gone status is returned.

", - "bodyParameters": [ - { - "description": "

Name of the project

", - "example": "Week One Sprint", - "type": "string", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "Name of the project", - "childParamsGroups": [] - }, - { - "description": "

Body of the project

", - "example": "This project represents the sprint of the first week in January", - "type": "string or null", - "nullable": true, - "name": "body", - "in": "body", - "rawType": "string", - "rawDescription": "Body of the project", - "childParamsGroups": [] - }, + "descriptionHTML": "

Approve or reject pending deployments that are waiting on approval by a required reviewer.

\n

Anyone with read access to the repository contents and deployments can use this endpoint.

", + "bodyParameters": [ { - "description": "

State of the project; either 'open' or 'closed'

", - "example": "open", - "type": "string", - "name": "state", + "type": "array of integers", + "description": "

Required. The list of environment ids to approve or reject

", + "example": [ + 161171787, + 161171795 + ], + "items": { + "type": "integer", + "example": 161171787 + }, + "name": "environment_ids", "in": "body", - "rawType": "string", - "rawDescription": "State of the project; either 'open' or 'closed'", + "rawType": "array", + "rawDescription": "The list of environment ids to approve or reject", "childParamsGroups": [] }, { - "description": "

The baseline permission that all organization members have on this project

", "type": "string", + "description": "

Required. Whether to approve or reject deployment to the specified environments. Must be one of: approved or rejected

", "enum": [ - "read", - "write", - "admin", - "none" + "approved", + "rejected" ], - "name": "organization_permission", + "example": "approved", + "name": "state", "in": "body", "rawType": "string", - "rawDescription": "The baseline permission that all organization members have on this project", + "rawDescription": "Whether to approve or reject deployment to the specified environments. Must be one of: `approved` or `rejected`", "childParamsGroups": [] }, { - "description": "

Whether or not this project can be seen by everyone.

", - "type": "boolean", - "name": "private", + "type": "string", + "description": "

Required. A comment to accompany the deployment review

", + "example": "Ship it!", + "name": "comment", "in": "body", - "rawType": "boolean", - "rawDescription": "Whether or not this project can be seen by everyone.", + "rawType": "string", + "rawDescription": "A comment to accompany the deployment review", "childParamsGroups": [] } ], @@ -19888,159 +27572,191 @@ "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"owner_url\": \"https://api.github.com/repos/api-playground/projects-test\",\n  \"url\": \"https://api.github.com/projects/1002604\",\n  \"html_url\": \"https://github.com/api-playground/projects-test/projects/1\",\n  \"columns_url\": \"https://api.github.com/projects/1002604/columns\",\n  \"id\": 1002604,\n  \"node_id\": \"MDc6UHJvamVjdDEwMDI2MDQ=\",\n  \"name\": \"Projects Documentation\",\n  \"body\": \"Developer documentation project for the developer site.\",\n  \"number\": 1,\n  \"state\": \"open\",\n  \"creator\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"created_at\": \"2011-04-10T20:09:31Z\",\n  \"updated_at\": \"2014-03-03T18:58:10Z\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Response if the authenticated user does not have access to the project" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "payload": "
[\n  {\n    \"url\": \"https://api.github.com/repos/octocat/example/deployments/1\",\n    \"id\": 1,\n    \"node_id\": \"MDEwOkRlcGxveW1lbnQx\",\n    \"sha\": \"a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d\",\n    \"ref\": \"topic-branch\",\n    \"task\": \"deploy\",\n    \"payload\": {},\n    \"original_environment\": \"staging\",\n    \"environment\": \"production\",\n    \"description\": \"Deploy request from hubot\",\n    \"creator\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"created_at\": \"2012-07-20T01:19:13Z\",\n    \"updated_at\": \"2012-07-20T01:19:13Z\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/example/deployments/1/statuses\",\n    \"repository_url\": \"https://api.github.com/repos/octocat/example\",\n    \"transient_environment\": false,\n    \"production_environment\": true\n  }\n]\n
" } ] }, { - "verb": "delete", - "requestPath": "/projects/{project_id}", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "project_id", + "name": "owner", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" }, "descriptionHTML": "" + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

The id of the workflow run

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/rerun", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/rerun
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /projects/{project_id}', {\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('DELETE /projects/{project_id}', {\n  project_id: 42,\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/actions/runs/{run_id}/rerun', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
" } ], - "summary": "Delete a project", - "description": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled.", - "operationId": "projects/delete", + "summary": "Re-run a workflow", + "description": "Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", "tags": [ - "projects" + "actions" ], + "operationId": "actions/re-run-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects/#delete-a-project" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#re-run-a-workflow" }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "projects", - "subcategory": null + "enabledForGitHubApps": false, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" }, - "slug": "delete-a-project", - "category": "projects", - "categoryLabel": "Projects", + "slug": "re-run-a-workflow", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", "notes": [], "responses": [ { - "httpStatusCode": "204", - "httpStatusMessage": "No Content", - "description": "Delete success" - }, + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Re-runs your workflow run using its id. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

" + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/runs/{run_id}/timing", + "serverUrl": "https://api.github.com", + "parameters": [ { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" }, { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" }, { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

The id of the workflow run

" + } + ], + "x-codeSamples": [ { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/runs/42/timing", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/runs/42/timing
" }, { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing', {\n owner: 'octocat',\n repo: 'hello-world',\n run_id: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/runs/{run_id}/timing', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  run_id: 42\n})\n
" } ], + "summary": "Get workflow run usage", + "description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub AE-hosted runners. Usage is listed for each GitHub AE-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-workflow-run-usage", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-workflow-run-usage" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "slug": "get-workflow-run-usage", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", + "notes": [], "bodyParameters": [], - "descriptionHTML": "

Deletes a project board. Returns a 404 Not Found status if projects are disabled.

" + "descriptionHTML": "

Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub AE-hosted runners. Usage is listed for each GitHub AE-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".

\n

Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"billable\": {\n    \"UBUNTU\": {\n      \"total_ms\": 180000,\n      \"jobs\": 1\n    },\n    \"MACOS\": {\n      \"total_ms\": 240000,\n      \"jobs\": 4\n    },\n    \"WINDOWS\": {\n      \"total_ms\": 300000,\n      \"jobs\": 2\n    }\n  },\n  \"run_duration_ms\": 500000\n}\n
" + } + ] }, { "verb": "get", - "requestPath": "/projects/{project_id}/collaborators", + "requestPath": "/repos/{owner}/{repo}/actions/secrets", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "project_id", + "name": "owner", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" }, "descriptionHTML": "" }, { - "name": "affiliation", - "description": "Filters the collaborators by their affiliation. Can be one of: \n\\* `outside`: Outside collaborators of a project that are not a member of the project's organization. \n\\* `direct`: Collaborators with permissions to a project, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", - "in": "query", - "required": false, + "name": "repo", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "outside", - "direct", - "all" - ], - "default": "all" + "type": "string" }, - "descriptionHTML": "

Filters the collaborators by their affiliation. Can be one of:
\n* outside: Outside collaborators of a project that are not a member of the project's organization.
\n* direct: Collaborators with permissions to a project, regardless of organization membership status.
\n* all: All collaborators the authenticated user can see.

" + "descriptionHTML": "" }, { "name": "per_page", @@ -20066,102 +27782,65 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/secrets", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/secrets
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /projects/{project_id}/collaborators', {\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('GET /projects/{project_id}/collaborators', {\n  project_id: 42,\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/secrets', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/secrets', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" } ], - "summary": "List project collaborators", - "description": "Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators.", + "summary": "List repository secrets", + "description": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", "tags": [ - "projects" + "actions" ], - "operationId": "projects/list-collaborators", + "operationId": "actions/list-repo-secrets", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#list-project-collaborators" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-repository-secrets" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "projects", - "subcategory": "collaborators" + "previews": [], + "category": "actions", + "subcategory": "secrets" }, - "slug": "list-project-collaborators", - "category": "projects", - "categoryLabel": "Projects", - "subcategory": "collaborators", - "subcategoryLabel": "Collaborators", + "slug": "list-repository-secrets", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project admin to list collaborators.

", + "descriptionHTML": "

Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n]\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "payload": "
{\n  \"total_count\": 2,\n  \"secrets\": [\n    {\n      \"name\": \"GH_TOKEN\",\n      \"created_at\": \"2019-08-10T14:59:22Z\",\n      \"updated_at\": \"2020-01-10T14:59:22Z\"\n    },\n    {\n      \"name\": \"GIST_ID\",\n      \"created_at\": \"2020-01-10T10:59:22Z\",\n      \"updated_at\": \"2020-01-11T11:59:22Z\"\n    }\n  ]\n}\n
" } ] }, { - "verb": "put", - "requestPath": "/projects/{project_id}/collaborators/{username}", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/secrets/public-key", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "project_id", + "name": "owner", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" }, "descriptionHTML": "" }, { - "name": "username", + "name": "repo", "in": "path", "required": true, "schema": { @@ -20173,353 +27852,366 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME \\\n -d '{\"permission\":\"permission\"}'", - "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME \\\n  -d '{\"permission\":\"permission\"}'
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/secrets/public-key", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/secrets/public-key
" }, { "lang": "JavaScript", - "source": "await octokit.request('PUT /projects/{project_id}/collaborators/{username}', {\n project_id: 42,\n username: 'username',\n permission: 'permission',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('PUT /projects/{project_id}/collaborators/{username}', {\n  project_id: 42,\n  username: 'username',\n  permission: 'permission',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/secrets/public-key', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/secrets/public-key', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" } ], - "summary": "Add project collaborator", - "description": "Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.", + "summary": "Get a repository public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint.", "tags": [ - "projects" + "actions" ], - "operationId": "projects/add-collaborator", + "operationId": "actions/get-repo-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#add-project-collaborator" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "description": "

The permission to grant the collaborator.

", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "example": "write", - "type": "string", - "name": "permission", - "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the collaborator.", - "childParamsGroups": [] - } - } - } - } - } + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-repository-public-key" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "projects", - "subcategory": "collaborators" + "previews": [], + "category": "actions", + "subcategory": "secrets" }, - "slug": "add-project-collaborator", - "category": "projects", - "categoryLabel": "Projects", - "subcategory": "collaborators", - "subcategoryLabel": "Collaborators", + "slug": "get-a-repository-public-key", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.

", "responses": [ { - "httpStatusCode": "204", - "httpStatusMessage": "No Content", - "description": "Default Response" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"key_id\": \"012345678912345678\",\n  \"key\": \"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"\n}\n
" + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", + "serverUrl": "https://api.github.com", + "parameters": [ { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" }, { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" }, { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

secret_name parameter

" + } + ], + "x-codeSamples": [ { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/secrets/SECRET_NAME", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/secrets/SECRET_NAME
" }, { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/secrets/{secret_name}', {\n owner: 'octocat',\n repo: 'hello-world',\n secret_name: 'secret_name'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/secrets/{secret_name}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  secret_name: 'secret_name'\n})\n
" } ], - "descriptionHTML": "

Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project admin to add a collaborator.

", - "bodyParameters": [ + "summary": "Get a repository secret", + "description": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-repository-secret" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "get-a-repository-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.

", + "responses": [ { - "description": "

The permission to grant the collaborator.

", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "example": "write", - "type": "string", - "name": "permission", - "in": "body", - "rawType": "string", - "rawDescription": "The permission to grant the collaborator.", - "childParamsGroups": [] + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"name\": \"GH_TOKEN\",\n  \"created_at\": \"2019-08-10T14:59:22Z\",\n  \"updated_at\": \"2020-01-10T14:59:22Z\"\n}\n
" } ] }, { - "verb": "delete", - "requestPath": "/projects/{project_id}/collaborators/{username}", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "project_id", + "name": "owner", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" }, "descriptionHTML": "" }, { - "name": "username", + "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

secret_name parameter

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/secrets/SECRET_NAME \\\n -d '{\"encrypted_value\":\"encrypted_value\"}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/secrets/SECRET_NAME \\\n  -d '{\"encrypted_value\":\"encrypted_value\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /projects/{project_id}/collaborators/{username}', {\n project_id: 42,\n username: 'username',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('DELETE /projects/{project_id}/collaborators/{username}', {\n  project_id: 42,\n  username: 'username',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}', {\n owner: 'octocat',\n repo: 'hello-world',\n secret_name: 'secret_name',\n encrypted_value: 'encrypted_value'\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/actions/secrets/{secret_name}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  secret_name: 'secret_name',\n  encrypted_value: 'encrypted_value'\n})\n
" } ], - "summary": "Remove user as a collaborator", - "description": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.", + "summary": "Create or update a repository secret", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", "tags": [ - "projects" + "actions" ], - "operationId": "projects/remove-collaborator", + "operationId": "actions/create-or-update-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#remove-project-collaborator" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-a-repository-secret" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", + "name": "encrypted_value", + "in": "body", + "rawType": "string", + "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-repository-public-key) endpoint.", + "childParamsGroups": [] + }, + "key_id": { + "type": "string", + "description": "

ID of the key you used to encrypt the secret.

", + "name": "key_id", + "in": "body", + "rawType": "string", + "rawDescription": "ID of the key you used to encrypt the secret.", + "childParamsGroups": [] + } + } + }, + "example": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "projects", - "subcategory": "collaborators" + "previews": [], + "category": "actions", + "subcategory": "secrets" }, - "slug": "remove-user-as-a-collaborator", - "category": "projects", - "categoryLabel": "Projects", - "subcategory": "collaborators", - "subcategoryLabel": "Collaborators", + "slug": "create-or-update-a-repository-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", "notes": [], "responses": [ { - "httpStatusCode": "204", - "httpStatusMessage": "No Content", - "description": "Default Response" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response when creating a secret" }, { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response when updating a secret" + } + ], + "descriptionHTML": "

Creates or updates a repository secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the tweetsodium library.

\n
const sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n  \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n  public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n  sealed_box = public.SealedBox(public_key)\n  encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n  return b64encode(encrypted).decode(\"utf-8\")\n
\n

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n
\n

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n
", + "bodyParameters": [ { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" + "type": "string", + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get a repository public key endpoint.

", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", + "name": "encrypted_value", + "in": "body", + "rawType": "string", + "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-repository-public-key) endpoint.", + "childParamsGroups": [] }, { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "type": "string", + "description": "

ID of the key you used to encrypt the secret.

", + "name": "key_id", + "in": "body", + "rawType": "string", + "rawDescription": "ID of the key you used to encrypt the secret.", + "childParamsGroups": [] } - ], - "bodyParameters": [], - "descriptionHTML": "

Removes a collaborator from an organization project. You must be an organization owner or a project admin to remove a collaborator.

" + ] }, { - "verb": "get", - "requestPath": "/projects/{project_id}/collaborators/{username}/permission", + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/actions/secrets/{secret_name}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "project_id", + "name": "owner", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" }, "descriptionHTML": "" }, { - "name": "username", + "name": "repo", "in": "path", "required": true, "schema": { "type": "string" }, "descriptionHTML": "" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

secret_name parameter

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/collaborators/USERNAME/permission", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/collaborators/USERNAME/permission
" + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/secrets/SECRET_NAME", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/secrets/SECRET_NAME
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /projects/{project_id}/collaborators/{username}/permission', {\n project_id: 42,\n username: 'username',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('GET /projects/{project_id}/collaborators/{username}/permission', {\n  project_id: 42,\n  username: 'username',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}', {\n owner: 'octocat',\n repo: 'hello-world',\n secret_name: 'secret_name'\n})", + "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/actions/secrets/{secret_name}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  secret_name: 'secret_name'\n})\n
" } ], - "summary": "Get project permission for a user", - "description": "Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.", + "summary": "Delete a repository secret", + "description": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", "tags": [ - "projects" + "actions" ], - "operationId": "projects/get-permission-for-user", + "operationId": "actions/delete-repo-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#get-project-permission-for-a-user" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-a-repository-secret" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "projects", - "subcategory": "collaborators" + "previews": [], + "category": "actions", + "subcategory": "secrets" }, - "slug": "get-project-permission-for-a-user", - "category": "projects", - "categoryLabel": "Projects", - "subcategory": "collaborators", - "subcategoryLabel": "Collaborators", + "slug": "delete-a-repository-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

Returns the collaborator's permission level for an organization project. Possible values for the permission key: admin, write, read, none. You must be an organization owner or a project admin to review a user's permission level.

", "responses": [ { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Default response", - "payload": "
{\n  \"permission\": \"admin\",\n  \"user\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  }\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" } - ] + ], + "bodyParameters": [], + "descriptionHTML": "

Deletes a secret in a repository using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.

" }, { "verb": "get", - "requestPath": "/projects/{project_id}/columns", + "requestPath": "/repos/{owner}/{repo}/actions/workflows", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "project_id", + "name": "owner", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" }, "descriptionHTML": "" }, @@ -20547,349 +28239,225 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/columns
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/workflows", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/workflows
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /projects/{project_id}/columns', {\n project_id: 42,\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('GET /projects/{project_id}/columns', {\n  project_id: 42,\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/workflows', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/workflows', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" } ], - "summary": "List project columns", - "description": "", + "summary": "List repository workflows", + "description": "Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ - "projects" + "actions" ], - "operationId": "projects/list-columns", + "operationId": "actions/list-repo-workflows", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#list-project-columns" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-repository-workflows" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "projects", - "subcategory": "columns" + "previews": [], + "category": "actions", + "subcategory": "workflows" }, - "slug": "list-project-columns", - "category": "projects", - "categoryLabel": "Projects", - "subcategory": "columns", - "subcategoryLabel": "Columns", + "slug": "list-repository-workflows", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflows", + "subcategoryLabel": "Workflows", "notes": [], "bodyParameters": [], - "descriptionHTML": "", + "descriptionHTML": "

Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"url\": \"https://api.github.com/projects/columns/367\",\n    \"project_url\": \"https://api.github.com/projects/120\",\n    \"cards_url\": \"https://api.github.com/projects/columns/367/cards\",\n    \"id\": 367,\n    \"node_id\": \"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\n    \"name\": \"To Do\",\n    \"created_at\": \"2016-09-05T14:18:44Z\",\n    \"updated_at\": \"2016-09-05T14:22:28Z\"\n  }\n]\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" + "payload": "
{\n  \"total_count\": 2,\n  \"workflows\": [\n    {\n      \"id\": 161335,\n      \"node_id\": \"MDg6V29ya2Zsb3cxNjEzMzU=\",\n      \"name\": \"CI\",\n      \"path\": \".github/workflows/blank.yaml\",\n      \"state\": \"active\",\n      \"created_at\": \"2020-01-08T23:48:37.000-08:00\",\n      \"updated_at\": \"2020-01-08T23:50:21.000-08:00\",\n      \"url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\n      \"html_url\": \"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\n      \"badge_url\": \"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"\n    },\n    {\n      \"id\": 269289,\n      \"node_id\": \"MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==\",\n      \"name\": \"Linter\",\n      \"path\": \".github/workflows/linter.yaml\",\n      \"state\": \"active\",\n      \"created_at\": \"2020-01-08T23:48:37.000-08:00\",\n      \"updated_at\": \"2020-01-08T23:50:21.000-08:00\",\n      \"url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289\",\n      \"html_url\": \"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289\",\n      \"badge_url\": \"https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg\"\n    }\n  ]\n}\n
" } ] }, { - "verb": "post", - "requestPath": "/projects/{project_id}/columns", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "project_id", + "name": "owner", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" }, "descriptionHTML": "" - } - ], - "x-codeSamples": [ + }, { - "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n https://api.github.com/projects/42/columns \\\n -d '{\"name\":\"name\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.inertia-preview+json\" \\\n  https://api.github.com/projects/42/columns \\\n  -d '{\"name\":\"name\"}'
" + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" }, { - "lang": "JavaScript", - "source": "await octokit.request('POST /projects/{project_id}/columns', {\n project_id: 42,\n name: 'name',\n mediaType: {\n previews: [\n 'inertia'\n ]\n }\n})", - "html": "
await octokit.request('POST /projects/{project_id}/columns', {\n  project_id: 42,\n  name: 'name',\n  mediaType: {\n    previews: [\n      'inertia'\n    ]\n  }\n})\n
" - } - ], - "summary": "Create a project column", - "description": "", - "tags": [ - "projects" - ], - "operationId": "projects/create-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#create-a-project-column" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "

Required. Name of the project column

", - "example": "Remaining tasks", - "type": "string", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "Name of the project column", - "childParamsGroups": [] - } + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" }, - "required": [ - "name" - ], - "type": "object" - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```", - "html": "

The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the blog post for full details. To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.inertia-preview+json
" - } - ], - "category": "projects", - "subcategory": "columns" - }, - "slug": "create-a-project-column", - "category": "projects", - "categoryLabel": "Projects", - "subcategory": "columns", - "subcategoryLabel": "Columns", - "notes": [], - "descriptionHTML": "", - "bodyParameters": [ - { - "description": "

Required. Name of the project column

", - "example": "Remaining tasks", - "type": "string", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "Name of the project column", - "childParamsGroups": [] + { + "type": "string" + } + ] + }, + "descriptionHTML": "

The ID of the workflow. You can also pass the workflow file name as a string.

" } ], - "responses": [ - { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response", - "payload": "
{\n  \"url\": \"https://api.github.com/projects/columns/367\",\n  \"project_url\": \"https://api.github.com/projects/120\",\n  \"cards_url\": \"https://api.github.com/projects/columns/367/cards\",\n  \"id\": 367,\n  \"node_id\": \"MDEzOlByb2plY3RDb2x1bW4zNjc=\",\n  \"name\": \"To Do\",\n  \"created_at\": \"2016-09-05T14:18:44Z\",\n  \"updated_at\": \"2016-09-05T14:22:28Z\"\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" - } - ] - }, - { - "verb": "get", - "requestPath": "/rate_limit", - "serverUrl": "https://api.github.com", - "parameters": [], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/rate_limit", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/rate_limit
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/workflows/42", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/workflows/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /rate_limit')", - "html": "
await octokit.request('GET /rate_limit')\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n workflow_id: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  workflow_id: 42\n})\n
" } ], - "summary": "Get rate limit status for the authenticated user", - "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "summary": "Get a workflow", + "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ - "rate-limit" + "actions" ], - "operationId": "rate-limit/get", + "operationId": "actions/get-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/rate_limit/#get-rate-limit-status-for-the-authenticated-user" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-workflow" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "category": "rate-limit", - "subcategory": null + "category": "actions", + "subcategory": "workflows" }, - "slug": "get-rate-limit-status-for-the-authenticated-user", - "category": "rate-limit", - "categoryLabel": "Rate limit", + "slug": "get-a-workflow", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflows", + "subcategoryLabel": "Workflows", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Note: Accessing this endpoint does not count against your REST API rate limit.

\n

Note: The rate object is deprecated. If you're writing new API client code or updating existing code, you should use the core object instead of the rate object. The core object contains the same information that is present in the rate object.

", + "descriptionHTML": "

Gets a specific workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"resources\": {\n    \"core\": {\n      \"limit\": 5000,\n      \"remaining\": 4999,\n      \"reset\": 1372700873\n    },\n    \"search\": {\n      \"limit\": 30,\n      \"remaining\": 18,\n      \"reset\": 1372697452\n    },\n    \"graphql\": {\n      \"limit\": 5000,\n      \"remaining\": 4993,\n      \"reset\": 1372700389\n    },\n    \"integration_manifest\": {\n      \"limit\": 5000,\n      \"remaining\": 4999,\n      \"reset\": 1551806725\n    },\n    \"code_scanning_upload\": {\n      \"limit\": 500,\n      \"remaining\": 499,\n      \"reset\": 1551806725\n    }\n  },\n  \"rate\": {\n    \"limit\": 5000,\n    \"remaining\": 4999,\n    \"reset\": 1372700873\n  }\n}\n
" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "payload": "
{\n  \"id\": 161335,\n  \"node_id\": \"MDg6V29ya2Zsb3cxNjEzMzU=\",\n  \"name\": \"CI\",\n  \"path\": \".github/workflows/blank.yaml\",\n  \"state\": \"active\",\n  \"created_at\": \"2020-01-08T23:48:37.000-08:00\",\n  \"updated_at\": \"2020-01-08T23:50:21.000-08:00\",\n  \"url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335\",\n  \"html_url\": \"https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335\",\n  \"badge_url\": \"https://github.com/octo-org/octo-repo/workflows/CI/badge.svg\"\n}\n
" } ] }, { - "verb": "delete", - "requestPath": "/reactions/{reaction_id}", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable", "serverUrl": "https://api.github.com", "parameters": [ { - "name": "reaction_id", + "name": "owner", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" }, "descriptionHTML": "" + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + }, + "descriptionHTML": "

The ID of the workflow. You can also pass the workflow file name as a string.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n https://api.github.com/reactions/42", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.squirrel-girl-preview+json\" \\\n  https://api.github.com/reactions/42
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/workflows/42/disable", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/workflows/42/disable
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /reactions/{reaction_id}', {\n reaction_id: 42,\n mediaType: {\n previews: [\n 'squirrel-girl'\n ]\n }\n})", - "html": "
await octokit.request('DELETE /reactions/{reaction_id}', {\n  reaction_id: 42,\n  mediaType: {\n    previews: [\n      'squirrel-girl'\n    ]\n  }\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable', {\n owner: 'octocat',\n repo: 'hello-world',\n workflow_id: 42\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  workflow_id: 42\n})\n
" } ], - "summary": "Delete a reaction (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/).\n\nOAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/github-ae@latest/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments).", + "summary": "Disable a workflow", + "description": "Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", "tags": [ - "reactions" + "actions" ], - "operationId": "reactions/delete-legacy", + "operationId": "actions/disable-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#delete-a-reaction-legacy" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#disable-a-workflow" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions.", - "html": "

An additional reactions object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the blog post for full details.

\n

To access the API you must provide a custom media type in the Accept header:

\n
application/vnd.github.squirrel-girl-preview
\n

The reactions key will have the following payload where url can be used to construct the API location for listing and creating reactions.

" - } - ], - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": null + "previews": [], + "category": "actions", + "subcategory": "workflows" }, - "deprecated": true, - "slug": "delete-a-reaction-legacy", - "category": "reactions", - "categoryLabel": "Reactions", + "slug": "disable-a-workflow", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflows", + "subcategoryLabel": "Workflows", "notes": [], "responses": [ { "httpStatusCode": "204", "httpStatusMessage": "No Content", "description": "Default Response" - }, - { - "httpStatusCode": "304", - "httpStatusMessage": "Not Modified", - "description": "Not modified" - }, - { - "httpStatusCode": "401", - "httpStatusMessage": "Unauthorized", - "description": "Requires authentication" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "410", - "httpStatusMessage": "Gone", - "description": "Gone" - }, - { - "httpStatusCode": "415", - "httpStatusMessage": "Unsupported Media Type", - "description": "Preview header missing" } ], "bodyParameters": [], - "descriptionHTML": "

Deprecation Notice: This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this blog post.

\n

OAuth access tokens require the write:discussion scope, when deleting a team discussion or team discussion comment.

" + "descriptionHTML": "

Disables a workflow and sets the state of the workflow to disabled_manually. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

\n

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

" }, { - "verb": "get", - "requestPath": "/repos/{owner}/{repo}", + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches", "serverUrl": "https://api.github.com", "parameters": [ { @@ -20909,89 +28477,139 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + }, + "descriptionHTML": "

The ID of the workflow. You can also pass the workflow file name as a string.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/workflows/42/dispatches \\\n -d '{\"ref\":\"ref\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/workflows/42/dispatches \\\n  -d '{\"ref\":\"ref\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /repos/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world'\n})", - "html": "
await octokit.request('GET /repos/{owner}/{repo}', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" + "source": "await octokit.request('POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches', {\n owner: 'octocat',\n repo: 'hello-world',\n workflow_id: 42,\n ref: 'ref'\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  workflow_id: 42,\n  ref: 'ref'\n})\n
" } ], - "summary": "Get a repository", - "description": "When you pass the `scarlet-witch-preview` media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.\n\nThe `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.", + "summary": "Create a workflow dispatch event", + "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"", + "operationId": "actions/create-workflow-dispatch", "tags": [ - "repos" + "actions" ], - "operationId": "repos/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#get-a-repository" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#create-a-workflow-dispatch-event" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "

Required. The git reference for the workflow. The reference can be a branch or tag name.

", + "name": "ref", + "in": "body", + "rawType": "string", + "rawDescription": "The git reference for the workflow. The reference can be a branch or tag name.", + "childParamsGroups": [] + }, + "inputs": { + "type": "object", + "description": "

Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.

", + "additionalProperties": { + "type": "string" + }, + "maxProperties": 10, + "name": "inputs", + "in": "body", + "rawType": "object", + "rawDescription": "Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.", + "childParamsGroups": [] + } + }, + "required": [ + "ref" + ] + }, + "example": { + "ref": "topic-branch", + "inputs": { + "name": "Mona the Octocat", + "home": "San Francisco, CA" + } + } + } + } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "nebula", - "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```", - "html": "

You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.

\n

To access repository visibility during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.nebula-preview+json
" - }, - { - "required": false, - "name": "scarlet-witch", - "note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```", - "html": "

The Codes of Conduct API is currently available for developers to preview.

\n

To access the API during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.scarlet-witch-preview+json
" - } - ], - "category": "repos", - "subcategory": null + "previews": [], + "category": "actions", + "subcategory": "workflows" }, - "slug": "get-a-repository", - "category": "repos", - "categoryLabel": "Repos", + "slug": "create-a-workflow-dispatch-event", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflows", + "subcategoryLabel": "Workflows", "notes": [], - "bodyParameters": [], - "descriptionHTML": "

When you pass the scarlet-witch-preview media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.

\n

The parent and source objects are present when the repository is a fork. parent is the repository this repository was forked from, source is the ultimate source for the network.

", "responses": [ { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Default response", - "payload": "
{\n  \"id\": 1296269,\n  \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n  \"name\": \"Hello-World\",\n  \"full_name\": \"octocat/Hello-World\",\n  \"owner\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"private\": false,\n  \"html_url\": \"https://github.com/octocat/Hello-World\",\n  \"description\": \"This your first repo!\",\n  \"fork\": false,\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n  \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n  \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n  \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n  \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n  \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n  \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n  \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n  \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n  \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n  \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n  \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n  \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n  \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n  \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n  \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n  \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n  \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n  \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n  \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n  \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n  \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n  \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n  \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n  \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n  \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n  \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n  \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n  \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n  \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n  \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n  \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n  \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n  \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n  \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n  \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n  \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n  \"homepage\": \"https://github.com\",\n  \"language\": null,\n  \"forks_count\": 9,\n  \"forks\": 9,\n  \"stargazers_count\": 80,\n  \"watchers_count\": 80,\n  \"watchers\": 80,\n  \"size\": 108,\n  \"default_branch\": \"master\",\n  \"open_issues_count\": 0,\n  \"open_issues\": 0,\n  \"is_template\": false,\n  \"topics\": [\n    \"octocat\",\n    \"atom\",\n    \"electron\",\n    \"api\"\n  ],\n  \"has_issues\": true,\n  \"has_projects\": true,\n  \"has_wiki\": true,\n  \"has_pages\": false,\n  \"has_downloads\": true,\n  \"archived\": false,\n  \"disabled\": false,\n  \"visibility\": \"public\",\n  \"pushed_at\": \"2011-01-26T19:06:43Z\",\n  \"created_at\": \"2011-01-26T19:01:12Z\",\n  \"updated_at\": \"2011-01-26T19:14:43Z\",\n  \"permissions\": {\n    \"pull\": true,\n    \"push\": false,\n    \"admin\": false\n  },\n  \"allow_rebase_merge\": true,\n  \"template_repository\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World-Template\",\n    \"full_name\": \"octocat/Hello-World-Template\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World-Template\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World-Template\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World-Template.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World-Template.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World-Template.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World-Template\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World-Template\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks\": 9,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"watchers\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues\": 0,\n    \"open_issues_count\": 0,\n    \"is_template\": true,\n    \"license\": {\n      \"key\": \"mit\",\n      \"name\": \"MIT License\",\n      \"url\": \"https://api.github.com/licenses/mit\",\n      \"spdx_id\": \"MIT\",\n      \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n      \"html_url\": \"https://api.github.com/licenses/mit\"\n    },\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"allow_rebase_merge\": true,\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"allow_squash_merge\": true,\n    \"delete_branch_on_merge\": true,\n    \"allow_merge_commit\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0\n  },\n  \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n  \"allow_squash_merge\": true,\n  \"delete_branch_on_merge\": true,\n  \"allow_merge_commit\": true,\n  \"subscribers_count\": 42,\n  \"network_count\": 0,\n  \"license\": {\n    \"key\": \"mit\",\n    \"name\": \"MIT License\",\n    \"spdx_id\": \"MIT\",\n    \"url\": \"https://api.github.com/licenses/mit\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n  },\n  \"organization\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"Organization\",\n    \"site_admin\": false\n  },\n  \"parent\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": true,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"allow_rebase_merge\": true,\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"allow_squash_merge\": true,\n    \"delete_branch_on_merge\": true,\n    \"allow_merge_commit\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0,\n    \"license\": {\n      \"key\": \"mit\",\n      \"name\": \"MIT License\",\n      \"url\": \"https://api.github.com/licenses/mit\",\n      \"spdx_id\": \"MIT\",\n      \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n      \"html_url\": \"https://api.github.com/licenses/mit\"\n    },\n    \"forks\": 1,\n    \"open_issues\": 1,\n    \"watchers\": 1\n  },\n  \"source\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": true,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"allow_rebase_merge\": true,\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"allow_squash_merge\": true,\n    \"delete_branch_on_merge\": true,\n    \"allow_merge_commit\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0,\n    \"license\": {\n      \"key\": \"mit\",\n      \"name\": \"MIT License\",\n      \"url\": \"https://api.github.com/licenses/mit\",\n      \"spdx_id\": \"MIT\",\n      \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n      \"html_url\": \"https://api.github.com/licenses/mit\"\n    },\n    \"forks\": 1,\n    \"open_issues\": 1,\n    \"watchers\": 1\n  }\n}\n
" - }, - { - "httpStatusCode": "200", - "httpStatusMessage": "OK", - "description": "Response with scarlet-witch-preview media type", - "payload": "
{\n  \"id\": 1296269,\n  \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n  \"name\": \"Hello-World\",\n  \"full_name\": \"octocat/Hello-World\",\n  \"owner\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"private\": false,\n  \"html_url\": \"https://github.com/octocat/Hello-World\",\n  \"description\": \"This your first repo!\",\n  \"fork\": false,\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n  \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n  \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n  \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n  \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n  \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n  \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n  \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n  \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n  \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n  \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n  \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n  \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n  \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n  \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n  \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n  \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n  \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n  \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n  \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n  \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n  \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n  \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n  \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n  \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n  \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n  \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n  \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n  \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n  \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n  \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n  \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n  \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n  \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n  \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n  \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n  \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n  \"homepage\": \"https://github.com\",\n  \"language\": null,\n  \"forks_count\": 9,\n  \"forks\": 9,\n  \"stargazers_count\": 80,\n  \"watchers_count\": 80,\n  \"watchers\": 80,\n  \"size\": 108,\n  \"default_branch\": \"master\",\n  \"open_issues_count\": 0,\n  \"open_issues\": 0,\n  \"is_template\": false,\n  \"topics\": [\n    \"octocat\",\n    \"atom\",\n    \"electron\",\n    \"api\"\n  ],\n  \"has_issues\": true,\n  \"has_projects\": true,\n  \"has_wiki\": true,\n  \"has_pages\": false,\n  \"has_downloads\": true,\n  \"archived\": false,\n  \"disabled\": false,\n  \"visibility\": \"public\",\n  \"pushed_at\": \"2011-01-26T19:06:43Z\",\n  \"created_at\": \"2011-01-26T19:01:12Z\",\n  \"updated_at\": \"2011-01-26T19:14:43Z\",\n  \"permissions\": {\n    \"pull\": true,\n    \"push\": false,\n    \"admin\": false\n  },\n  \"allow_rebase_merge\": true,\n  \"template_repository\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World-Template\",\n    \"full_name\": \"octocat/Hello-World-Template\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World-Template\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World-Template\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World-Template.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World-Template.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World-Template.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World-Template\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World-Template\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks\": 9,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"watchers\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues\": 0,\n    \"open_issues_count\": 0,\n    \"is_template\": true,\n    \"license\": {\n      \"key\": \"mit\",\n      \"name\": \"MIT License\",\n      \"url\": \"https://api.github.com/licenses/mit\",\n      \"spdx_id\": \"MIT\",\n      \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n      \"html_url\": \"https://api.github.com/licenses/mit\"\n    },\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"allow_rebase_merge\": true,\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"allow_squash_merge\": true,\n    \"delete_branch_on_merge\": true,\n    \"allow_merge_commit\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0\n  },\n  \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n  \"allow_squash_merge\": true,\n  \"delete_branch_on_merge\": true,\n  \"allow_merge_commit\": true,\n  \"subscribers_count\": 42,\n  \"network_count\": 0,\n  \"license\": {\n    \"key\": \"mit\",\n    \"name\": \"MIT License\",\n    \"spdx_id\": \"MIT\",\n    \"url\": \"https://api.github.com/licenses/mit\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\"\n  },\n  \"organization\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"Organization\",\n    \"site_admin\": false\n  },\n  \"parent\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": true,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"allow_rebase_merge\": true,\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"allow_squash_merge\": true,\n    \"delete_branch_on_merge\": true,\n    \"allow_merge_commit\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0,\n    \"license\": {\n      \"key\": \"mit\",\n      \"name\": \"MIT License\",\n      \"url\": \"https://api.github.com/licenses/mit\",\n      \"spdx_id\": \"MIT\",\n      \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n      \"html_url\": \"https://api.github.com/licenses/mit\"\n    },\n    \"forks\": 1,\n    \"open_issues\": 1,\n    \"watchers\": 1\n  },\n  \"source\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": true,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"allow_rebase_merge\": true,\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"allow_squash_merge\": true,\n    \"delete_branch_on_merge\": true,\n    \"allow_merge_commit\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0,\n    \"license\": {\n      \"key\": \"mit\",\n      \"name\": \"MIT License\",\n      \"url\": \"https://api.github.com/licenses/mit\",\n      \"spdx_id\": \"MIT\",\n      \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n      \"html_url\": \"https://api.github.com/licenses/mit\"\n    },\n    \"forks\": 1,\n    \"open_issues\": 1,\n    \"watchers\": 1\n  },\n  \"code_of_conduct\": {\n    \"key\": \"other\",\n    \"name\": \"Other\",\n    \"html_url\": \"https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md\",\n    \"url\": \"https://api.github.com/repos/github/docs/community/code_of_conduct\"\n  }\n}\n
" - }, - { - "httpStatusCode": "301", - "httpStatusMessage": "Moved Permanently", - "description": "Moved permanently" - }, + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "descriptionHTML": "

You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

\n

You must configure your GitHub Actions workflow to run when the workflow_dispatch webhook event occurs. The inputs are configured in the workflow file. For more information about how to configure the workflow_dispatch event in the workflow file, see \"Events that trigger workflows.\"

\n

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint. For more information, see \"Creating a personal access token for the command line.\"

", + "bodyParameters": [ { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" + "type": "string", + "description": "

Required. The git reference for the workflow. The reference can be a branch or tag name.

", + "name": "ref", + "in": "body", + "rawType": "string", + "rawDescription": "The git reference for the workflow. The reference can be a branch or tag name.", + "childParamsGroups": [] }, { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "type": "object", + "description": "

Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when inputs are omitted.

", + "additionalProperties": { + "type": "string" + }, + "maxProperties": 10, + "name": "inputs", + "in": "body", + "rawType": "object", + "rawDescription": "Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.", + "childParamsGroups": [] } ] }, { - "verb": "patch", - "requestPath": "/repos/{owner}/{repo}", + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable", "serverUrl": "https://api.github.com", "parameters": [ { @@ -21011,406 +28629,235 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + }, + "descriptionHTML": "

The ID of the workflow. You can also pass the workflow file name as a string.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world \\\n -d '{\"name\":\"name\"}'", - "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world \\\n  -d '{\"name\":\"name\"}'
" + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/workflows/42/enable", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/workflows/42/enable
" }, { "lang": "JavaScript", - "source": "await octokit.request('PATCH /repos/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world',\n name: 'name'\n})", - "html": "
await octokit.request('PATCH /repos/{owner}/{repo}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  name: 'name'\n})\n
" + "source": "await octokit.request('PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable', {\n owner: 'octocat',\n repo: 'hello-world',\n workflow_id: 42\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  workflow_id: 42\n})\n
" } ], - "summary": "Update a repository", - "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/github-ae@latest/rest/reference/repos#replace-all-repository-topics) endpoint.", + "summary": "Enable a workflow", + "description": "Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", "tags": [ - "repos" + "actions" ], - "operationId": "repos/update", + "operationId": "actions/enable-workflow", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#update-a-repository" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "

The name of the repository.

", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "childParamsGroups": [] - }, - "description": { - "type": "string", - "description": "

A short description of the repository.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "childParamsGroups": [] - }, - "homepage": { - "type": "string", - "description": "

A URL with more information about the repository.

", - "name": "homepage", - "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "childParamsGroups": [] - }, - "private": { - "type": "boolean", - "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", - "default": false, - "name": "private", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", - "childParamsGroups": [] - }, - "visibility": { - "type": "string", - "description": "

Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. The visibility parameter overrides the private parameter when you use both along with the nebula-preview preview header.

", - "enum": [ - "public", - "private", - "visibility", - "internal" - ], - "name": "visibility", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header.", - "childParamsGroups": [] - }, - "has_issues": { - "type": "boolean", - "description": "

Either true to enable issues for this repository or false to disable them.

", - "default": true, - "name": "has_issues", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", - "childParamsGroups": [] - }, - "has_projects": { - "type": "boolean", - "description": "

Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

", - "default": true, - "name": "has_projects", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "childParamsGroups": [] - }, - "has_wiki": { - "type": "boolean", - "description": "

Either true to enable the wiki for this repository or false to disable it.

", - "default": true, - "name": "has_wiki", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "childParamsGroups": [] - }, - "is_template": { - "type": "boolean", - "description": "

Either true to make this repo available as a template repository or false to prevent it.

", - "default": false, - "name": "is_template", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "childParamsGroups": [] - }, - "default_branch": { - "type": "string", - "description": "

Updates the default branch for this repository.

", - "name": "default_branch", - "in": "body", - "rawType": "string", - "rawDescription": "Updates the default branch for this repository.", - "childParamsGroups": [] - }, - "allow_squash_merge": { - "type": "boolean", - "description": "

Either true to allow squash-merging pull requests, or false to prevent squash-merging.

", - "default": true, - "name": "allow_squash_merge", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "childParamsGroups": [] - }, - "allow_merge_commit": { - "type": "boolean", - "description": "

Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

", - "default": true, - "name": "allow_merge_commit", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "childParamsGroups": [] - }, - "allow_rebase_merge": { - "type": "boolean", - "description": "

Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

", - "default": true, - "name": "allow_rebase_merge", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "childParamsGroups": [] - }, - "delete_branch_on_merge": { - "type": "boolean", - "description": "

Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

", - "default": false, - "name": "delete_branch_on_merge", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "childParamsGroups": [] - }, - "archived": { - "type": "boolean", - "description": "

true to archive this repository. Note: You cannot unarchive repositories through the API.

", - "default": false, - "name": "archived", - "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", - "childParamsGroups": [] - } - } - }, - "example": { - "name": "Hello-World", - "description": "This is your first repository", - "homepage": "https://github.com", - "private": true, - "has_issues": true, - "has_projects": true, - "has_wiki": true - } - } - } + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#enable-a-workflow" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "nebula", - "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```", - "html": "

You can set the visibility of a repository using the new visibility parameter in the Repositories API, and get a repository's visibility with a new response key. For more information, see the blog post.

\n

To access repository visibility during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.nebula-preview+json
" - }, - { - "required": false, - "name": "baptiste", - "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```", - "html": "

The is_template and template_repository keys are currently available for developer to preview. See Create a repository using a template to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom media type in the Accept header:

\n
application/vnd.github.baptiste-preview+json
" - } - ], - "category": "repos", - "subcategory": null + "previews": [], + "category": "actions", + "subcategory": "workflows" }, - "slug": "update-a-repository", - "category": "repos", - "categoryLabel": "Repos", + "slug": "enable-a-workflow", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflows", + "subcategoryLabel": "Workflows", "notes": [], - "descriptionHTML": "

Note: To edit a repository's topics, use the Replace all repository topics endpoint.

", - "bodyParameters": [ - { - "type": "string", - "description": "

The name of the repository.

", - "name": "name", - "in": "body", - "rawType": "string", - "rawDescription": "The name of the repository.", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

A short description of the repository.

", - "name": "description", - "in": "body", - "rawType": "string", - "rawDescription": "A short description of the repository.", - "childParamsGroups": [] - }, - { - "type": "string", - "description": "

A URL with more information about the repository.

", - "name": "homepage", - "in": "body", - "rawType": "string", - "rawDescription": "A URL with more information about the repository.", - "childParamsGroups": [] - }, + "responses": [ { - "type": "boolean", - "description": "

Either true to make the repository private or false to make it public. Default: false.
\nNote: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private. Note: You will get a 422 error if the organization restricts changing repository visibility to organization owners and a non-owner tries to change the value of private.

", - "default": false, - "name": "private", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", - "childParamsGroups": [] - }, + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Enables a workflow and sets the state of the workflow to active. You can replace workflow_id with the workflow file name. For example, you could use main.yaml.

\n

You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the actions:write permission to use this endpoint.

" + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs", + "serverUrl": "https://api.github.com", + "parameters": [ { - "type": "string", - "description": "

Can be public or private. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, visibility can also be internal. The visibility parameter overrides the private parameter when you use both along with the nebula-preview preview header.

", - "enum": [ - "public", - "private", - "visibility", - "internal" - ], - "name": "visibility", - "in": "body", - "rawType": "string", - "rawDescription": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header.", - "childParamsGroups": [] + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" }, { - "type": "boolean", - "description": "

Either true to enable issues for this repository or false to disable them.

", - "default": true, - "name": "has_issues", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable issues for this repository or `false` to disable them.", - "childParamsGroups": [] + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" }, { - "type": "boolean", - "description": "

Either true to enable projects for this repository or false to disable them. Note: If you're creating a repository in an organization that has disabled repository projects, the default is false, and if you pass true, the API returns an error.

", - "default": true, - "name": "has_projects", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "childParamsGroups": [] + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + }, + "descriptionHTML": "

The ID of the workflow. You can also pass the workflow file name as a string.

" }, { - "type": "boolean", - "description": "

Either true to enable the wiki for this repository or false to disable it.

", - "default": true, - "name": "has_wiki", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "childParamsGroups": [] + "name": "actor", + "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

Returns someone's workflow runs. Use the login for the user who created the push associated with the check suite or workflow run.

" }, { - "type": "boolean", - "description": "

Either true to make this repo available as a template repository or false to prevent it.

", - "default": false, - "name": "is_template", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "childParamsGroups": [] + "name": "branch", + "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

Returns workflow runs associated with a branch. Use the name of the branch of the push.

" }, { - "type": "string", - "description": "

Updates the default branch for this repository.

", - "name": "default_branch", - "in": "body", - "rawType": "string", - "rawDescription": "Updates the default branch for this repository.", - "childParamsGroups": [] + "name": "event", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

Returns workflow run triggered by the event you specify. For example, push, pull_request or issue. For more information, see \"Events that trigger workflows.\"

" }, { - "type": "boolean", - "description": "

Either true to allow squash-merging pull requests, or false to prevent squash-merging.

", - "default": true, - "name": "allow_squash_merge", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "childParamsGroups": [] + "name": "status", + "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/github-ae@latest/rest/reference/checks#create-a-check-run).\"", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "action_required", + "cancelled", + "failure", + "neutral", + "skipped", + "stale", + "success", + "timed_out", + "in_progress", + "queued", + "requested", + "waiting" + ] + }, + "descriptionHTML": "

Returns workflow runs with the check run status or conclusion that you specify. For example, a conclusion can be success or a status can be in_progress. Only GitHub can set a status of waiting or requested. For a list of the possible status and conclusion options, see \"Create a check run.\"

" }, { - "type": "boolean", - "description": "

Either true to allow merging pull requests with a merge commit, or false to prevent merging pull requests with merge commits.

", - "default": true, - "name": "allow_merge_commit", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "childParamsGroups": [] + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" }, { - "type": "boolean", - "description": "

Either true to allow rebase-merging pull requests, or false to prevent rebase-merging.

", - "default": true, - "name": "allow_rebase_merge", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "childParamsGroups": [] - }, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + } + ], + "x-codeSamples": [ { - "type": "boolean", - "description": "

Either true to allow automatically deleting head branches when pull requests are merged, or false to prevent automatic deletion.

", - "default": false, - "name": "delete_branch_on_merge", - "in": "body", - "rawType": "boolean", - "rawDescription": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "childParamsGroups": [] + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/workflows/42/runs", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/workflows/42/runs
" }, { - "type": "boolean", - "description": "

true to archive this repository. Note: You cannot unarchive repositories through the API.

", - "default": false, - "name": "archived", - "in": "body", - "rawType": "boolean", - "rawDescription": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", - "childParamsGroups": [] + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs', {\n owner: 'octocat',\n repo: 'hello-world',\n workflow_id: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  workflow_id: 42\n})\n
" } ], + "summary": "List workflow runs", + "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", + "tags": [ + "actions" + ], + "operationId": "actions/list-workflow-runs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-workflow-runs" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "workflow-runs" + }, + "slug": "list-workflow-runs", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflow-runs", + "subcategoryLabel": "Workflow runs", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

List all workflow runs for a workflow. You can replace workflow_id with the workflow file name. For example, you could use main.yaml. You can use parameters to narrow the list of results. For more information about using parameters, see Parameters.

\n

Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"id\": 1296269,\n  \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n  \"name\": \"Hello-World\",\n  \"full_name\": \"octocat/Hello-World\",\n  \"owner\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"private\": false,\n  \"html_url\": \"https://github.com/octocat/Hello-World\",\n  \"description\": \"This your first repo!\",\n  \"fork\": false,\n  \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n  \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n  \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n  \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n  \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n  \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n  \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n  \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n  \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n  \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n  \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n  \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n  \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n  \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n  \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n  \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n  \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n  \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n  \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n  \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n  \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n  \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n  \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n  \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n  \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n  \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n  \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n  \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n  \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n  \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n  \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n  \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n  \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n  \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n  \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n  \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n  \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n  \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n  \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n  \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n  \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n  \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n  \"homepage\": \"https://github.com\",\n  \"license\": {\n    \"key\": \"mit\",\n    \"name\": \"MIT License\",\n    \"url\": \"https://api.github.com/licenses/mit\",\n    \"spdx_id\": \"MIT\",\n    \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n    \"html_url\": \"https://github.com/licenses/mit\"\n  },\n  \"language\": null,\n  \"forks_count\": 9,\n  \"forks\": 9,\n  \"stargazers_count\": 80,\n  \"watchers_count\": 80,\n  \"watchers\": 80,\n  \"size\": 108,\n  \"default_branch\": \"master\",\n  \"open_issues_count\": 0,\n  \"open_issues\": 0,\n  \"is_template\": false,\n  \"topics\": [\n    \"octocat\",\n    \"atom\",\n    \"electron\",\n    \"api\"\n  ],\n  \"has_issues\": true,\n  \"has_projects\": true,\n  \"has_wiki\": true,\n  \"has_pages\": false,\n  \"has_downloads\": true,\n  \"archived\": false,\n  \"disabled\": false,\n  \"visibility\": \"public\",\n  \"pushed_at\": \"2011-01-26T19:06:43Z\",\n  \"created_at\": \"2011-01-26T19:01:12Z\",\n  \"updated_at\": \"2011-01-26T19:14:43Z\",\n  \"permissions\": {\n    \"pull\": true,\n    \"push\": false,\n    \"admin\": false\n  },\n  \"allow_rebase_merge\": true,\n  \"template_repository\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World-Template\",\n    \"full_name\": \"octocat/Hello-World-Template\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World-Template\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World-Template\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World-Template.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World-Template.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World-Template.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World-Template\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World-Template\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks\": 9,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"watchers\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues\": 0,\n    \"open_issues_count\": 0,\n    \"is_template\": true,\n    \"license\": {\n      \"key\": \"mit\",\n      \"name\": \"MIT License\",\n      \"url\": \"https://api.github.com/licenses/mit\",\n      \"spdx_id\": \"MIT\",\n      \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n      \"html_url\": \"https://api.github.com/licenses/mit\"\n    },\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"allow_rebase_merge\": true,\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"allow_squash_merge\": true,\n    \"delete_branch_on_merge\": true,\n    \"allow_merge_commit\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0\n  },\n  \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n  \"allow_squash_merge\": true,\n  \"delete_branch_on_merge\": true,\n  \"allow_merge_commit\": true,\n  \"subscribers_count\": 42,\n  \"network_count\": 0,\n  \"organization\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"Organization\",\n    \"site_admin\": false\n  },\n  \"parent\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": true,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"allow_rebase_merge\": true,\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"allow_squash_merge\": true,\n    \"delete_branch_on_merge\": true,\n    \"allow_merge_commit\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0,\n    \"license\": {\n      \"key\": \"mit\",\n      \"name\": \"MIT License\",\n      \"url\": \"https://api.github.com/licenses/mit\",\n      \"spdx_id\": \"MIT\",\n      \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n      \"html_url\": \"https://api.github.com/licenses/mit\"\n    },\n    \"forks\": 1,\n    \"open_issues\": 1,\n    \"watchers\": 1\n  },\n  \"source\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": true,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"allow_rebase_merge\": true,\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"allow_squash_merge\": true,\n    \"delete_branch_on_merge\": true,\n    \"allow_merge_commit\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0,\n    \"license\": {\n      \"key\": \"mit\",\n      \"name\": \"MIT License\",\n      \"url\": \"https://api.github.com/licenses/mit\",\n      \"spdx_id\": \"MIT\",\n      \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n      \"html_url\": \"https://api.github.com/licenses/mit\"\n    },\n    \"forks\": 1,\n    \"open_issues\": 1,\n    \"watchers\": 1\n  }\n}\n
" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "Forbidden" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" - }, - { - "httpStatusCode": "422", - "httpStatusMessage": "Unprocessable Entity", - "description": "Validation failed" + "payload": "
{\n  \"total_count\": 1,\n  \"workflow_runs\": [\n    {\n      \"id\": 30433642,\n      \"name\": \"Build\",\n      \"node_id\": \"MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==\",\n      \"head_branch\": \"master\",\n      \"head_sha\": \"acb5820ced9479c074f688cc328bf03f341a511d\",\n      \"run_number\": 562,\n      \"event\": \"push\",\n      \"status\": \"queued\",\n      \"conclusion\": null,\n      \"workflow_id\": 159038,\n      \"url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642\",\n      \"html_url\": \"https://github.com/octo-org/octo-repo/actions/runs/30433642\",\n      \"pull_requests\": [],\n      \"created_at\": \"2020-01-22T19:33:08Z\",\n      \"updated_at\": \"2020-01-22T19:33:08Z\",\n      \"jobs_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs\",\n      \"logs_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs\",\n      \"check_suite_url\": \"https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374\",\n      \"artifacts_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts\",\n      \"cancel_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel\",\n      \"rerun_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun\",\n      \"workflow_url\": \"https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038\",\n      \"head_commit\": {\n        \"id\": \"acb5820ced9479c074f688cc328bf03f341a511d\",\n        \"tree_id\": \"d23f6eedb1e1b9610bbc754ddb5197bfe7271223\",\n        \"message\": \"Create linter.yaml\",\n        \"timestamp\": \"2020-01-22T19:33:05Z\",\n        \"author\": {\n          \"name\": \"Octo Cat\",\n          \"email\": \"octocat@github.com\"\n        },\n        \"committer\": {\n          \"name\": \"GitHub\",\n          \"email\": \"noreply@github.com\"\n        }\n      },\n      \"repository\": {\n        \"id\": 1296269,\n        \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n        \"name\": \"Hello-World\",\n        \"full_name\": \"octocat/Hello-World\",\n        \"owner\": {\n          \"login\": \"octocat\",\n          \"id\": 1,\n          \"node_id\": \"MDQ6VXNlcjE=\",\n          \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n          \"gravatar_id\": \"\",\n          \"url\": \"https://api.github.com/users/octocat\",\n          \"html_url\": \"https://github.com/octocat\",\n          \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n          \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n          \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n          \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n          \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n          \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n          \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n          \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n          \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n          \"type\": \"User\",\n          \"site_admin\": false\n        },\n        \"private\": false,\n        \"html_url\": \"https://github.com/octocat/Hello-World\",\n        \"description\": \"This your first repo!\",\n        \"fork\": false,\n        \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n        \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n        \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n        \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n        \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n        \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n        \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n        \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n        \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n        \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n        \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n        \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n        \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n        \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n        \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n        \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n        \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n        \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n        \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n        \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n        \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n        \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n        \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n        \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n        \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n        \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n        \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n        \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n        \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n        \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n        \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n        \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n        \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n        \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n        \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n        \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n        \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n        \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n        \"hooks_url\": \"http://api.github.com/repos/octocat/Hello-World/hooks\"\n      },\n      \"head_repository\": {\n        \"id\": 217723378,\n        \"node_id\": \"MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=\",\n        \"name\": \"octo-repo\",\n        \"full_name\": \"octo-org/octo-repo\",\n        \"private\": true,\n        \"owner\": {\n          \"login\": \"octocat\",\n          \"id\": 1,\n          \"node_id\": \"MDQ6VXNlcjE=\",\n          \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n          \"gravatar_id\": \"\",\n          \"url\": \"https://api.github.com/users/octocat\",\n          \"html_url\": \"https://github.com/octocat\",\n          \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n          \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n          \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n          \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n          \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n          \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n          \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n          \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n          \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n          \"type\": \"User\",\n          \"site_admin\": false\n        },\n        \"html_url\": \"https://github.com/octo-org/octo-repo\",\n        \"description\": null,\n        \"fork\": false,\n        \"url\": \"https://api.github.com/repos/octo-org/octo-repo\",\n        \"forks_url\": \"https://api.github.com/repos/octo-org/octo-repo/forks\",\n        \"keys_url\": \"https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}\",\n        \"collaborators_url\": \"https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}\",\n        \"teams_url\": \"https://api.github.com/repos/octo-org/octo-repo/teams\",\n        \"hooks_url\": \"https://api.github.com/repos/octo-org/octo-repo/hooks\",\n        \"issue_events_url\": \"https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}\",\n        \"events_url\": \"https://api.github.com/repos/octo-org/octo-repo/events\",\n        \"assignees_url\": \"https://api.github.com/repos/octo-org/octo-repo/assignees{/user}\",\n        \"branches_url\": \"https://api.github.com/repos/octo-org/octo-repo/branches{/branch}\",\n        \"tags_url\": \"https://api.github.com/repos/octo-org/octo-repo/tags\",\n        \"blobs_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}\",\n        \"git_tags_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}\",\n        \"git_refs_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}\",\n        \"trees_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}\",\n        \"statuses_url\": \"https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}\",\n        \"languages_url\": \"https://api.github.com/repos/octo-org/octo-repo/languages\",\n        \"stargazers_url\": \"https://api.github.com/repos/octo-org/octo-repo/stargazers\",\n        \"contributors_url\": \"https://api.github.com/repos/octo-org/octo-repo/contributors\",\n        \"subscribers_url\": \"https://api.github.com/repos/octo-org/octo-repo/subscribers\",\n        \"subscription_url\": \"https://api.github.com/repos/octo-org/octo-repo/subscription\",\n        \"commits_url\": \"https://api.github.com/repos/octo-org/octo-repo/commits{/sha}\",\n        \"git_commits_url\": \"https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}\",\n        \"comments_url\": \"https://api.github.com/repos/octo-org/octo-repo/comments{/number}\",\n        \"issue_comment_url\": \"https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}\",\n        \"contents_url\": \"https://api.github.com/repos/octo-org/octo-repo/contents/{+path}\",\n        \"compare_url\": \"https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}\",\n        \"merges_url\": \"https://api.github.com/repos/octo-org/octo-repo/merges\",\n        \"archive_url\": \"https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}\",\n        \"downloads_url\": \"https://api.github.com/repos/octo-org/octo-repo/downloads\",\n        \"issues_url\": \"https://api.github.com/repos/octo-org/octo-repo/issues{/number}\",\n        \"pulls_url\": \"https://api.github.com/repos/octo-org/octo-repo/pulls{/number}\",\n        \"milestones_url\": \"https://api.github.com/repos/octo-org/octo-repo/milestones{/number}\",\n        \"notifications_url\": \"https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}\",\n        \"labels_url\": \"https://api.github.com/repos/octo-org/octo-repo/labels{/name}\",\n        \"releases_url\": \"https://api.github.com/repos/octo-org/octo-repo/releases{/id}\",\n        \"deployments_url\": \"https://api.github.com/repos/octo-org/octo-repo/deployments\"\n      }\n    }\n  ]\n}\n
" } ] }, { - "verb": "delete", - "requestPath": "/repos/{owner}/{repo}", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing", "serverUrl": "https://api.github.com", "parameters": [ { @@ -21430,59 +28877,68 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + }, + "descriptionHTML": "

The ID of the workflow. You can also pass the workflow file name as a string.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world", - "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/actions/workflows/42/timing", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/actions/workflows/42/timing
" }, { "lang": "JavaScript", - "source": "await octokit.request('DELETE /repos/{owner}/{repo}', {\n owner: 'octocat',\n repo: 'hello-world'\n})", - "html": "
await octokit.request('DELETE /repos/{owner}/{repo}', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing', {\n owner: 'octocat',\n repo: 'hello-world',\n workflow_id: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  workflow_id: 42\n})\n
" } ], - "summary": "Delete a repository", - "description": "Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a `403 Forbidden` response.", + "summary": "Get workflow usage", + "description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub AE-hosted runners. Usage is listed for each GitHub AE-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ - "repos" + "actions" ], - "operationId": "repos/delete", + "operationId": "actions/get-workflow-usage", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#delete-a-repository" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-workflow-usage" }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "previews": [], - "category": "repos", - "subcategory": null + "category": "actions", + "subcategory": "workflows" }, - "slug": "delete-a-repository", - "category": "repos", - "categoryLabel": "Repos", + "slug": "get-workflow-usage", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "workflows", + "subcategoryLabel": "Workflows", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Deleting a repository requires admin access. If OAuth is used, the delete_repo scope is required.

\n

If an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a 403 Forbidden response.

", + "descriptionHTML": "

Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub AE-hosted runners. Usage is listed for each GitHub AE-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"Managing billing for GitHub Actions\".

\n

You can replace workflow_id with the workflow file name. For example, you could use main.yaml. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

", "responses": [ { - "httpStatusCode": "204", - "httpStatusMessage": "No Content", - "description": "Default Response" - }, - { - "httpStatusCode": "403", - "httpStatusMessage": "Forbidden", - "description": "If an organization owner has configured the organization to prevent members from deleting organization owned repositories a member will get this response", - "payload": "
{\n  \"message\": \"Organization members cannot delete repositories.\",\n  \"documentation_url\": \"https://docs.github.com/github-ae@latest/rest/reference/repos#delete-a-repository\"\n}\n
" - }, - { - "httpStatusCode": "404", - "httpStatusMessage": "Not Found", - "description": "Resource not found" + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"billable\": {\n    \"UBUNTU\": {\n      \"total_ms\": 180000\n    },\n    \"MACOS\": {\n      \"total_ms\": 240000\n    },\n    \"WINDOWS\": {\n      \"total_ms\": 300000\n    }\n  }\n}\n
" } ] }, @@ -30697,7 +38153,511 @@ }, { "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", + "requestPath": "/repos/{owner}/{repo}/check-runs/{check_run_id}/annotations", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "check_run_id", + "description": "check_run_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

check_run_id parameter

" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42/annotations", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42/annotations
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations', {\n owner: 'octocat',\n repo: 'hello-world',\n check_run_id: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  check_run_id: 42\n})\n
" + } + ], + "summary": "List check run annotations", + "description": "Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository.", + "tags": [ + "checks" + ], + "operationId": "checks/list-annotations", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#list-check-run-annotations" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "checks", + "subcategory": "runs" + }, + "slug": "list-check-run-annotations", + "category": "checks", + "categoryLabel": "Checks", + "subcategory": "runs", + "subcategoryLabel": "Runs", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
[\n  {\n    \"path\": \"README.md\",\n    \"start_line\": 2,\n    \"end_line\": 2,\n    \"start_column\": 5,\n    \"end_column\": 10,\n    \"annotation_level\": \"warning\",\n    \"title\": \"Spell Checker\",\n    \"message\": \"Check your spelling for 'banaas'.\",\n    \"raw_details\": \"Do you mean 'bananas' or 'banana'?\",\n    \"blob_href\": \"https://api.github.com/repos/github/rest-api-description/git/blobs/abc\"\n  }\n]\n
" + } + ] + }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/check-suites", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites \\\n -d '{\"head_sha\":\"head_sha\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites \\\n  -d '{\"head_sha\":\"head_sha\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/check-suites', {\n owner: 'octocat',\n repo: 'hello-world',\n head_sha: 'head_sha'\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/check-suites', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  head_sha: 'head_sha'\n})\n
" + } + ], + "summary": "Create a check suite", + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nBy default, check suites are automatically created when you create a [check run](https://docs.github.com/github-ae@latest/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/github-ae@latest/rest/reference/checks#update-repository-preferences-for-check-suites)\". Your GitHub App must have the `checks:write` permission to create check suites.", + "tags": [ + "checks" + ], + "operationId": "checks/create-suite", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#create-a-check-suite" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "head_sha": { + "type": "string", + "description": "

Required. The sha of the head commit.

", + "name": "head_sha", + "in": "body", + "rawType": "string", + "rawDescription": "The sha of the head commit.", + "childParamsGroups": [] + } + }, + "required": [ + "head_sha" + ] + }, + "example": { + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "checks", + "subcategory": "suites" + }, + "slug": "create-a-check-suite", + "category": "checks", + "categoryLabel": "Checks", + "subcategory": "suites", + "subcategoryLabel": "Suites", + "notes": [], + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\". Your GitHub App must have the checks:write permission to create check suites.

", + "bodyParameters": [ + { + "type": "string", + "description": "

Required. The sha of the head commit.

", + "name": "head_sha", + "in": "body", + "rawType": "string", + "rawDescription": "The sha of the head commit.", + "childParamsGroups": [] + } + ], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Default response", + "payload": "
{\n  \"id\": 5,\n  \"node_id\": \"MDEwOkNoZWNrU3VpdGU1\",\n  \"head_branch\": \"master\",\n  \"head_sha\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n  \"status\": \"completed\",\n  \"conclusion\": \"neutral\",\n  \"url\": \"https://api.github.com/repos/github/hello-world/check-suites/5\",\n  \"before\": \"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\n  \"after\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n  \"pull_requests\": [],\n  \"created_at\": \"2017-07-08T16:18:44-04:00\",\n  \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n  \"app\": {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  },\n  \"repository\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"template_repository\": {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World-Template\",\n      \"full_name\": \"octocat/Hello-World-Template\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World-Template\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World-Template\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World-Template.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World-Template.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World-Template.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World-Template\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World-Template\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks\": 9,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"watchers\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues\": 0,\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://api.github.com/licenses/mit\"\n      },\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0\n    },\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": false,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"delete_branch_on_merge\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0\n  },\n  \"head_commit\": {\n    \"id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n    \"tree_id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n    \"message\": \"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\n    \"timestamp\": \"2016-10-10T00:00:00Z\",\n    \"author\": {\n      \"name\": \"The Octocat\",\n      \"email\": \"octocat@nowhere.com\"\n    },\n    \"committer\": {\n      \"name\": \"The Octocat\",\n      \"email\": \"octocat@nowhere.com\"\n    }\n  },\n  \"latest_check_runs_count\": 1,\n  \"check_runs_url\": \"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"\n}\n
" + } + ] + }, + { + "verb": "patch", + "requestPath": "/repos/{owner}/{repo}/check-suites/preferences", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/preferences \\\n -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'", + "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/preferences \\\n  -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PATCH /repos/{owner}/{repo}/check-suites/preferences', {\n owner: 'octocat',\n repo: 'hello-world',\n auto_trigger_checks: [\n {\n app_id: 42,\n setting: true\n }\n ]\n})", + "html": "
await octokit.request('PATCH /repos/{owner}/{repo}/check-suites/preferences', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  auto_trigger_checks: [\n    {\n      app_id: 42,\n      setting: true\n    }\n  ]\n})\n
" + } + ], + "summary": "Update repository preferences for check suites", + "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/github-ae@latest/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.", + "tags": [ + "checks" + ], + "operationId": "checks/set-suites-preferences", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#update-repository-preferences-for-check-suites" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "auto_trigger_checks": { + "type": "array of objects", + "description": "

Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

", + "items": { + "type": "object", + "properties": { + "app_id": { + "type": "integer", + "description": "

Required. The id of the GitHub App.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The `id` of the GitHub App.", + "childParamsGroups": [] + }, + "setting": { + "type": "boolean", + "description": "

Required. Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

", + "default": true, + "name": "setting", + "in": "body", + "rawType": "boolean", + "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", + "childParamsGroups": [] + } + }, + "required": [ + "app_id", + "setting" + ] + }, + "name": "auto_trigger_checks", + "in": "body", + "rawType": "array", + "rawDescription": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/github-ae@latest/rest/reference/checks#auto_trigger_checks-object) description for details.", + "childParamsGroups": [ + { + "parentName": "auto_trigger_checks", + "parentType": "items", + "id": "auto_trigger_checks-items", + "params": [ + { + "type": "integer", + "description": "

Required. The id of the GitHub App.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The `id` of the GitHub App.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Required. Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

", + "default": true, + "name": "setting", + "in": "body", + "rawType": "boolean", + "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", + "childParamsGroups": [] + } + ] + } + ] + } + } + }, + "example": { + "auto_trigger_checks": [ + { + "app_id": 4, + "setting": false + } + ] + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "checks", + "subcategory": "suites" + }, + "slug": "update-repository-preferences-for-check-suites", + "category": "checks", + "categoryLabel": "Checks", + "subcategory": "suites", + "subcategoryLabel": "Suites", + "notes": [], + "descriptionHTML": "

Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite. You must have admin permissions in the repository to set preferences for check suites.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"preferences\": {\n    \"auto_trigger_checks\": [\n      {\n        \"app_id\": 2,\n        \"setting\": true\n      },\n      {\n        \"app_id\": 4,\n        \"setting\": false\n      }\n    ]\n  },\n  \"repository\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": true,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"allow_rebase_merge\": true,\n    \"template_repository\": null,\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"allow_squash_merge\": true,\n    \"delete_branch_on_merge\": true,\n    \"allow_merge_commit\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0,\n    \"license\": {\n      \"key\": \"mit\",\n      \"name\": \"MIT License\",\n      \"url\": \"https://api.github.com/licenses/mit\",\n      \"spdx_id\": \"MIT\",\n      \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n      \"html_url\": \"http://choosealicense.com/licenses/mit/\"\n    },\n    \"forks\": 1,\n    \"open_issues\": 1,\n    \"watchers\": 1\n  }\n}\n
" + } + ], + "bodyParameters": [ + { + "type": "array of objects", + "description": "

Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

", + "items": { + "type": "object", + "properties": { + "app_id": { + "type": "integer", + "description": "

Required. The id of the GitHub App.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The `id` of the GitHub App.", + "childParamsGroups": [] + }, + "setting": { + "type": "boolean", + "description": "

Required. Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

", + "default": true, + "name": "setting", + "in": "body", + "rawType": "boolean", + "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", + "childParamsGroups": [] + } + }, + "required": [ + "app_id", + "setting" + ] + }, + "name": "auto_trigger_checks", + "in": "body", + "rawType": "array", + "rawDescription": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/github-ae@latest/rest/reference/checks#auto_trigger_checks-object) description for details.", + "childParamsGroups": [ + { + "parentName": "auto_trigger_checks", + "parentType": "items", + "id": "auto_trigger_checks-items", + "params": [ + { + "type": "integer", + "description": "

Required. The id of the GitHub App.

", + "name": "app_id", + "in": "body", + "rawType": "integer", + "rawDescription": "The `id` of the GitHub App.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Required. Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

", + "default": true, + "name": "setting", + "in": "body", + "rawType": "boolean", + "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "check_suite_id", + "description": "check_suite_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

check_suite_id parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/check-suites/{check_suite_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n check_suite_id: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/check-suites/{check_suite_id}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  check_suite_id: 42\n})\n
" + } + ], + "summary": "Get a check suite", + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nGets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", + "tags": [ + "checks" + ], + "operationId": "checks/get-suite", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#get-a-check-suite" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "checks", + "subcategory": "suites" + }, + "slug": "get-a-check-suite", + "category": "checks", + "categoryLabel": "Checks", + "subcategory": "suites", + "subcategoryLabel": "Suites", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"id\": 5,\n  \"node_id\": \"MDEwOkNoZWNrU3VpdGU1\",\n  \"head_branch\": \"master\",\n  \"head_sha\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n  \"status\": \"completed\",\n  \"conclusion\": \"neutral\",\n  \"url\": \"https://api.github.com/repos/github/hello-world/check-suites/5\",\n  \"before\": \"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\n  \"after\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n  \"pull_requests\": [],\n  \"created_at\": \"2017-07-08T16:18:44-04:00\",\n  \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n  \"app\": {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  },\n  \"repository\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"template_repository\": {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World-Template\",\n      \"full_name\": \"octocat/Hello-World-Template\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World-Template\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World-Template\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World-Template.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World-Template.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World-Template.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World-Template\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World-Template\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks\": 9,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"watchers\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues\": 0,\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://api.github.com/licenses/mit\"\n      },\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0\n    },\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": false,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"delete_branch_on_merge\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0\n  },\n  \"head_commit\": {\n    \"id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n    \"tree_id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n    \"message\": \"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\n    \"timestamp\": \"2016-10-10T00:00:00Z\",\n    \"author\": {\n      \"name\": \"The Octocat\",\n      \"email\": \"octocat@nowhere.com\"\n    },\n    \"committer\": {\n      \"name\": \"The Octocat\",\n      \"email\": \"octocat@nowhere.com\"\n    }\n  },\n  \"latest_check_runs_count\": 1,\n  \"check_runs_url\": \"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"\n}\n
" + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", "serverUrl": "https://api.github.com", "parameters": [ { @@ -30719,14 +38679,54 @@ "descriptionHTML": "" }, { - "name": "check_run_id", - "description": "check_run_id parameter", + "name": "check_suite_id", + "description": "check_suite_id parameter", "in": "path", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "

check_run_id parameter

" + "descriptionHTML": "

check_suite_id parameter

" + }, + { + "name": "check_name", + "description": "Returns check runs with the specified `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + }, + "descriptionHTML": "

Returns check runs with the specified name.

" + }, + { + "name": "status", + "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ] + }, + "descriptionHTML": "

Returns check runs with the specified status. Can be one of queued, in_progress, or completed.

" + }, + { + "name": "filter", + "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "latest", + "all" + ], + "default": "latest" + }, + "descriptionHTML": "

Filters check runs by their completed_at timestamp. Can be one of latest (returning the most recent check runs) or all.

" }, { "name": "per_page", @@ -30752,24 +38752,24 @@ "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-runs/42/annotations", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-runs/42/annotations
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/check-runs", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42/check-runs
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations', {\n owner: 'octocat',\n repo: 'hello-world',\n check_run_id: 42\n})", - "html": "
await octokit.request('GET /repos/{owner}/{repo}/check-runs/{check_run_id}/annotations', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  check_run_id: 42\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs', {\n owner: 'octocat',\n repo: 'hello-world',\n check_suite_id: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  check_suite_id: 42\n})\n
" } ], - "summary": "List check run annotations", - "description": "Lists annotations for a check run using the annotation `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the `repo` scope to get annotations for a check run in a private repository.", + "summary": "List check runs in a check suite", + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", "tags": [ "checks" ], - "operationId": "checks/list-annotations", + "operationId": "checks/list-for-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#list-check-run-annotations" + "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#list-check-runs-in-a-check-suite" }, "x-github": { "githubCloudOnly": false, @@ -30778,26 +38778,26 @@ "category": "checks", "subcategory": "runs" }, - "slug": "list-check-run-annotations", + "slug": "list-check-runs-in-a-check-suite", "category": "checks", "categoryLabel": "Checks", "subcategory": "runs", "subcategoryLabel": "Runs", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Lists annotations for a check run using the annotation id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get annotations for a check run. OAuth Apps and authenticated users must have the repo scope to get annotations for a check run in a private repository.

", + "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
[\n  {\n    \"path\": \"README.md\",\n    \"start_line\": 2,\n    \"end_line\": 2,\n    \"start_column\": 5,\n    \"end_column\": 10,\n    \"annotation_level\": \"warning\",\n    \"title\": \"Spell Checker\",\n    \"message\": \"Check your spelling for 'banaas'.\",\n    \"raw_details\": \"Do you mean 'bananas' or 'banana'?\",\n    \"blob_href\": \"https://api.github.com/repos/github/rest-api-description/git/blobs/abc\"\n  }\n]\n
" + "payload": "
{\n  \"total_count\": 1,\n  \"check_runs\": [\n    {\n      \"id\": 4,\n      \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n      \"node_id\": \"MDg6Q2hlY2tSdW40\",\n      \"external_id\": \"\",\n      \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n      \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n      \"details_url\": \"https://example.com\",\n      \"status\": \"completed\",\n      \"conclusion\": \"neutral\",\n      \"started_at\": \"2018-05-04T01:14:52Z\",\n      \"completed_at\": \"2018-05-04T01:14:52Z\",\n      \"output\": {\n        \"title\": \"Mighty Readme report\",\n        \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n        \"text\": \"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\n        \"annotations_count\": 2,\n        \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n      },\n      \"name\": \"mighty_readme\",\n      \"check_suite\": {\n        \"id\": 5\n      },\n      \"app\": {\n        \"id\": 1,\n        \"slug\": \"octoapp\",\n        \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n        \"owner\": {\n          \"login\": \"github\",\n          \"id\": 1,\n          \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n          \"url\": \"https://api.github.com/orgs/github\",\n          \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n          \"events_url\": \"https://api.github.com/orgs/github/events\",\n          \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n          \"gravatar_id\": \"\",\n          \"html_url\": \"https://github.com/octocat\",\n          \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n          \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n          \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n          \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n          \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n          \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n          \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n          \"type\": \"User\",\n          \"site_admin\": true\n        },\n        \"name\": \"Octocat App\",\n        \"description\": \"\",\n        \"external_url\": \"https://example.com\",\n        \"html_url\": \"https://github.com/apps/octoapp\",\n        \"created_at\": \"2017-07-08T16:18:44-04:00\",\n        \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n        \"permissions\": {\n          \"metadata\": \"read\",\n          \"contents\": \"read\",\n          \"issues\": \"write\",\n          \"single_file\": \"write\"\n        },\n        \"events\": [\n          \"push\",\n          \"pull_request\"\n        ]\n      },\n      \"pull_requests\": [\n        {\n          \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n          \"id\": 1934,\n          \"number\": 3956,\n          \"head\": {\n            \"ref\": \"say-hello\",\n            \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n            \"repo\": {\n              \"id\": 526,\n              \"url\": \"https://api.github.com/repos/github/hello-world\",\n              \"name\": \"hello-world\"\n            }\n          },\n          \"base\": {\n            \"ref\": \"master\",\n            \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n            \"repo\": {\n              \"id\": 526,\n              \"url\": \"https://api.github.com/repos/github/hello-world\",\n              \"name\": \"hello-world\"\n            }\n          }\n        }\n      ]\n    }\n  ]\n}\n
" } ] }, { "verb": "post", - "requestPath": "/repos/{owner}/{repo}/check-suites", + "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", "serverUrl": "https://api.github.com", "parameters": [ { @@ -30817,55 +38817,39 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "name": "check_suite_id", + "description": "check_suite_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "

check_suite_id parameter

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites \\\n -d '{\"head_sha\":\"head_sha\"}'", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites \\\n  -d '{\"head_sha\":\"head_sha\"}'
" + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/rerequest", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42/rerequest
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /repos/{owner}/{repo}/check-suites', {\n owner: 'octocat',\n repo: 'hello-world',\n head_sha: 'head_sha'\n})", - "html": "
await octokit.request('POST /repos/{owner}/{repo}/check-suites', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  head_sha: 'head_sha'\n})\n
" + "source": "await octokit.request('POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest', {\n owner: 'octocat',\n repo: 'hello-world',\n check_suite_id: 42\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  check_suite_id: 42\n})\n
" } ], - "summary": "Create a check suite", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nBy default, check suites are automatically created when you create a [check run](https://docs.github.com/github-ae@latest/rest/reference/checks#check-runs). You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"[Update repository preferences for check suites](https://docs.github.com/github-ae@latest/rest/reference/checks#update-repository-preferences-for-check-suites)\". Your GitHub App must have the `checks:write` permission to create check suites.", + "summary": "Rerequest a check suite", + "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.", "tags": [ "checks" ], - "operationId": "checks/create-suite", + "operationId": "checks/rerequest-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#create-a-check-suite" - }, - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "head_sha": { - "type": "string", - "description": "

Required. The sha of the head commit.

", - "name": "head_sha", - "in": "body", - "rawType": "string", - "rawDescription": "The sha of the head commit.", - "childParamsGroups": [] - } - }, - "required": [ - "head_sha" - ] - }, - "example": { - "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3" - } - } - } + "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#rerequest-a-check-suite" }, "x-github": { "githubCloudOnly": false, @@ -30874,36 +38858,274 @@ "category": "checks", "subcategory": "suites" }, - "slug": "create-a-check-suite", + "slug": "rerequest-a-check-suite", "category": "checks", "categoryLabel": "Checks", "subcategory": "suites", "subcategoryLabel": "Suites", "notes": [], - "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

By default, check suites are automatically created when you create a check run. You only need to use this endpoint for manually creating check suites when you've disabled automatic creation using \"Update repository preferences for check suites\". Your GitHub App must have the checks:write permission to create check suites.

", - "bodyParameters": [ + "responses": [ { - "type": "string", - "description": "

Required. The sha of the head commit.

", - "name": "head_sha", - "in": "body", - "rawType": "string", - "rawDescription": "The sha of the head commit.", - "childParamsGroups": [] + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.

\n

To rerequest a check suite, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.

" + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "tool_name", + "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + }, + "descriptionHTML": "

The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both.

" + }, + { + "name": "tool_guid", + "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", + "in": "query", + "required": false, + "schema": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + }, + "descriptionHTML": "

The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both.

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "ref", + "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`." + }, + "descriptionHTML": "

The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

" + }, + { + "name": "state", + "description": "Set to `open`, `fixed`, or `dismissed` to list code scanning alerts in a specific state.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "descriptionHTML": "

Set to open, fixed, or dismissed to list code scanning alerts in a specific state.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/code-scanning/alerts", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/code-scanning/alerts
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/code-scanning/alerts', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/code-scanning/alerts', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" } ], + "summary": "List code scanning alerts for a repository", + "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/list-alerts-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": null + }, + "slug": "list-code-scanning-alerts-for-a-repository", + "category": "code-scanning", + "categoryLabel": "Code scanning", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Lists all open code scanning alerts for the default branch (usually main\nor master). You must use an access token with the security_events scope to use\nthis endpoint. GitHub Apps must have the security_events read permission to use\nthis endpoint.

\n

The response includes a most_recent_instance object.\nThis provides details of the most recent instance of this alert\nfor the the default branch or for the specified Git reference\n(if you used ref in the request).

", "responses": [ { - "httpStatusCode": "201", - "httpStatusMessage": "Created", + "httpStatusCode": "200", + "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"id\": 5,\n  \"node_id\": \"MDEwOkNoZWNrU3VpdGU1\",\n  \"head_branch\": \"master\",\n  \"head_sha\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n  \"status\": \"completed\",\n  \"conclusion\": \"neutral\",\n  \"url\": \"https://api.github.com/repos/github/hello-world/check-suites/5\",\n  \"before\": \"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\n  \"after\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n  \"pull_requests\": [],\n  \"created_at\": \"2017-07-08T16:18:44-04:00\",\n  \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n  \"app\": {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  },\n  \"repository\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"template_repository\": {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World-Template\",\n      \"full_name\": \"octocat/Hello-World-Template\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World-Template\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World-Template\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World-Template.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World-Template.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World-Template.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World-Template\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World-Template\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks\": 9,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"watchers\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues\": 0,\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://api.github.com/licenses/mit\"\n      },\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0\n    },\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": false,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"delete_branch_on_merge\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0\n  },\n  \"head_commit\": {\n    \"id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n    \"tree_id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n    \"message\": \"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\n    \"timestamp\": \"2016-10-10T00:00:00Z\",\n    \"author\": {\n      \"name\": \"The Octocat\",\n      \"email\": \"octocat@nowhere.com\"\n    },\n    \"committer\": {\n      \"name\": \"The Octocat\",\n      \"email\": \"octocat@nowhere.com\"\n    }\n  },\n  \"latest_check_runs_count\": 1,\n  \"check_runs_url\": \"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"\n}\n
" + "payload": "
[\n  {\n    \"number\": 4,\n    \"created_at\": \"2020-02-13T12:29:18Z\",\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4\",\n    \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/4\",\n    \"state\": \"open\",\n    \"dismissed_by\": null,\n    \"dismissed_at\": null,\n    \"dismissed_reason\": null,\n    \"rule\": {\n      \"id\": \"js/zipslip\",\n      \"severity\": \"error\",\n      \"description\": \"Arbitrary file write during zip extraction\",\n      \"name\": \"js/zipslip\"\n    },\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"most_recent_instance\": {\n      \"ref\": \"refs/heads/main\",\n      \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n      \"environment\": \"{}\",\n      \"state\": \"open\",\n      \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n      \"message\": {\n        \"text\": \"This path depends on a user-provided value.\"\n      },\n      \"location\": {\n        \"path\": \"spec-main/api-session-spec.ts\",\n        \"start_line\": 917,\n        \"end_line\": 917,\n        \"start_column\": 7,\n        \"end_column\": 18\n      },\n      \"classifications\": [\n        \"test\"\n      ]\n    },\n    \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances\"\n  },\n  {\n    \"number\": 3,\n    \"created_at\": \"2020-02-13T12:29:18Z\",\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3\",\n    \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/3\",\n    \"state\": \"dismissed\",\n    \"dismissed_by\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"dismissed_at\": \"2020-02-14T12:29:18Z\",\n    \"dismissed_reason\": \"false positive\",\n    \"rule\": {\n      \"id\": \"js/zipslip\",\n      \"severity\": \"error\",\n      \"description\": \"Arbitrary file write during zip extraction\",\n      \"name\": \"js/zipslip\"\n    },\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"most_recent_instance\": {\n      \"ref\": \"refs/heads/main\",\n      \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n      \"environment\": \"{}\",\n      \"state\": \"open\",\n      \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n      \"message\": {\n        \"text\": \"This path depends on a user-provided value.\"\n      },\n      \"location\": {\n        \"path\": \"lib/ab12-gen.js\",\n        \"start_line\": 917,\n        \"end_line\": 917,\n        \"start_column\": 7,\n        \"end_column\": 18\n      },\n      \"classifications\": []\n    },\n    \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances\"\n  }\n]\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if github advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "alert_number", + "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "required": true, + "schema": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + }, + "descriptionHTML": "

The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n alert_number: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  alert_number: 42\n})\n
" + } + ], + "summary": "Get a code scanning alert", + "description": "Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/get-alert", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#get-a-code-scanning-alert" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "code-scanning", + "subcategory": null + }, + "slug": "get-a-code-scanning-alert", + "category": "code-scanning", + "categoryLabel": "Code scanning", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Gets a single code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events read permission to use this endpoint.

\n

Deprecation notice:\nThe instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by instances_url.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-06-19T11:21:34Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 54933897,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-02-14T12:29:18Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if github advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" } ] }, { "verb": "patch", - "requestPath": "/repos/{owner}/{repo}/check-suites/preferences", + "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}", "serverUrl": "https://api.github.com", "parameters": [ { @@ -30923,29 +39145,42 @@ "type": "string" }, "descriptionHTML": "" + }, + { + "name": "alert_number", + "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "required": true, + "schema": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + }, + "descriptionHTML": "

The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/preferences \\\n -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'", - "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/preferences \\\n  -d '{\"auto_trigger_checks\":[{\"app_id\":42,\"setting\":true}]}'
" + "source": "curl \\\n -X PATCH \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42 \\\n -d '{\"state\":\"state\"}'", + "html": "
curl \\\n  -X PATCH \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42 \\\n  -d '{\"state\":\"state\"}'
" }, { "lang": "JavaScript", - "source": "await octokit.request('PATCH /repos/{owner}/{repo}/check-suites/preferences', {\n owner: 'octocat',\n repo: 'hello-world',\n auto_trigger_checks: [\n {\n app_id: 42,\n setting: true\n }\n ]\n})", - "html": "
await octokit.request('PATCH /repos/{owner}/{repo}/check-suites/preferences', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  auto_trigger_checks: [\n    {\n      app_id: 42,\n      setting: true\n    }\n  ]\n})\n
" + "source": "await octokit.request('PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}', {\n owner: 'octocat',\n repo: 'hello-world',\n alert_number: 42,\n state: 'state'\n})", + "html": "
await octokit.request('PATCH /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  alert_number: 42,\n  state: 'state'\n})\n
" } ], - "summary": "Update repository preferences for check suites", - "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/github-ae@latest/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.", + "summary": "Update a code scanning alert", + "description": "Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.", + "operationId": "code-scanning/update-alert", "tags": [ - "checks" + "code-scanning" ], - "operationId": "checks/set-suites-preferences", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#update-repository-preferences-for-check-suites" + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#update-a-code-scanning-alert" }, "requestBody": { "content": { @@ -30953,175 +39188,132 @@ "schema": { "type": "object", "properties": { - "auto_trigger_checks": { - "type": "array of objects", - "description": "

Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

", - "items": { - "type": "object", - "properties": { - "app_id": { - "type": "integer", - "description": "

Required. The id of the GitHub App.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The `id` of the GitHub App.", - "childParamsGroups": [] - }, - "setting": { - "type": "boolean", - "description": "

Required. Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

", - "default": true, - "name": "setting", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "childParamsGroups": [] - } - }, - "required": [ - "app_id", - "setting" - ] - }, - "name": "auto_trigger_checks", + "state": { + "description": "

Required. Sets the state of the code scanning alert. Can be one of open or dismissed. You must provide dismissed_reason when you set the state to dismissed.

", + "type": "string", + "enum": [ + "open", + "dismissed" + ], + "name": "state", "in": "body", - "rawType": "array", - "rawDescription": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/github-ae@latest/rest/reference/checks#auto_trigger_checks-object) description for details.", - "childParamsGroups": [ + "rawType": "string", + "rawDescription": "Sets the state of the code scanning alert. Can be one of `open` or `dismissed`. You must provide `dismissed_reason` when you set the state to `dismissed`.", + "childParamsGroups": [] + }, + "dismissed_reason": { + "type": "string or null", + "description": "

Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "nullable": true, + "oneOf": [ { - "parentName": "auto_trigger_checks", - "parentType": "items", - "id": "auto_trigger_checks-items", - "params": [ - { - "type": "integer", - "description": "

Required. The id of the GitHub App.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The `id` of the GitHub App.", - "childParamsGroups": [] - }, - { - "type": "boolean", - "description": "

Required. Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

", - "default": true, - "name": "setting", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "childParamsGroups": [] - } + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + }, + { + "enum": [ + null ] } - ] + ], + "name": "dismissed_reason", + "in": "body", + "rawType": "string", + "rawDescription": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "childParamsGroups": [] } - } + }, + "required": [ + "state" + ] }, "example": { - "auto_trigger_checks": [ - { - "app_id": 4, - "setting": false - } - ] + "state": "dismissed", + "dismissed_reason": "false positive" } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "previews": [], - "category": "checks", - "subcategory": "suites" + "category": "code-scanning" }, - "slug": "update-repository-preferences-for-check-suites", - "category": "checks", - "categoryLabel": "Checks", - "subcategory": "suites", - "subcategoryLabel": "Suites", + "slug": "update-a-code-scanning-alert", + "category": "code-scanning", + "categoryLabel": "Code scanning", "notes": [], - "descriptionHTML": "

Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually Create a check suite. You must have admin permissions in the repository to set preferences for check suites.

", + "descriptionHTML": "

Updates the status of a single code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

", + "bodyParameters": [ + { + "description": "

Required. Sets the state of the code scanning alert. Can be one of open or dismissed. You must provide dismissed_reason when you set the state to dismissed.

", + "type": "string", + "enum": [ + "open", + "dismissed" + ], + "name": "state", + "in": "body", + "rawType": "string", + "rawDescription": "Sets the state of the code scanning alert. Can be one of `open` or `dismissed`. You must provide `dismissed_reason` when you set the state to `dismissed`.", + "childParamsGroups": [] + }, + { + "type": "string or null", + "description": "

Required when the state is dismissed. The reason for dismissing or closing the alert. Can be one of: false positive, won't fix, and used in tests.

", + "nullable": true, + "oneOf": [ + { + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + }, + { + "enum": [ + null + ] + } + ], + "name": "dismissed_reason", + "in": "body", + "rawType": "string", + "rawDescription": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "childParamsGroups": [] + } + ], "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"preferences\": {\n    \"auto_trigger_checks\": [\n      {\n        \"app_id\": 2,\n        \"setting\": true\n      },\n      {\n        \"app_id\": 4,\n        \"setting\": false\n      }\n    ]\n  },\n  \"repository\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": true,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"allow_rebase_merge\": true,\n    \"template_repository\": null,\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"allow_squash_merge\": true,\n    \"delete_branch_on_merge\": true,\n    \"allow_merge_commit\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0,\n    \"license\": {\n      \"key\": \"mit\",\n      \"name\": \"MIT License\",\n      \"url\": \"https://api.github.com/licenses/mit\",\n      \"spdx_id\": \"MIT\",\n      \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n      \"html_url\": \"http://choosealicense.com/licenses/mit/\"\n    },\n    \"forks\": 1,\n    \"open_issues\": 1,\n    \"watchers\": 1\n  }\n}\n
" - } - ], - "bodyParameters": [ + "payload": "
{\n  \"number\": 42,\n  \"created_at\": \"2020-08-25T21:28:36Z\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42\",\n  \"html_url\": \"https://github.com/octocat/hello-world/code-scanning/42\",\n  \"state\": \"dismissed\",\n  \"dismissed_by\": {\n    \"login\": \"octocat\",\n    \"id\": 1,\n    \"node_id\": \"MDQ6VXNlcjE=\",\n    \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n    \"gravatar_id\": \"\",\n    \"url\": \"https://api.github.com/users/octocat\",\n    \"html_url\": \"https://github.com/octocat\",\n    \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n    \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n    \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n    \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n    \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n    \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n    \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n    \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n    \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n    \"type\": \"User\",\n    \"site_admin\": false\n  },\n  \"dismissed_at\": \"2020-09-02T22:34:56Z\",\n  \"dismissed_reason\": \"false positive\",\n  \"rule\": {\n    \"id\": \"js/zipslip\",\n    \"severity\": \"error\",\n    \"description\": \"Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\",\n    \"name\": \"js/zipslip\",\n    \"full_description\": \"Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.\",\n    \"tags\": [\n      \"security\",\n      \"external/cwe/cwe-022\"\n    ],\n    \"help\": \"# Arbitrary file write during zip extraction (\\\"Zip Slip\\\")\\\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ...\"\n  },\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"most_recent_instance\": {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"{}\",\n    \"state\": \"dismissed\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"spec-main/api-session-spec.ts\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"test\"\n    ]\n  },\n  \"instances_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances\"\n}\n
" + }, { - "type": "array of objects", - "description": "

Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the auto_trigger_checks object description for details.

", - "items": { - "type": "object", - "properties": { - "app_id": { - "type": "integer", - "description": "

Required. The id of the GitHub App.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The `id` of the GitHub App.", - "childParamsGroups": [] - }, - "setting": { - "type": "boolean", - "description": "

Required. Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

", - "default": true, - "name": "setting", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "childParamsGroups": [] - } - }, - "required": [ - "app_id", - "setting" - ] - }, - "name": "auto_trigger_checks", - "in": "body", - "rawType": "array", - "rawDescription": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/github-ae@latest/rest/reference/checks#auto_trigger_checks-object) description for details.", - "childParamsGroups": [ - { - "parentName": "auto_trigger_checks", - "parentType": "items", - "id": "auto_trigger_checks-items", - "params": [ - { - "type": "integer", - "description": "

Required. The id of the GitHub App.

", - "name": "app_id", - "in": "body", - "rawType": "integer", - "rawDescription": "The `id` of the GitHub App.", - "childParamsGroups": [] - }, - { - "type": "boolean", - "description": "

Required. Set to true to enable automatic creation of CheckSuite events upon pushes to the repository, or false to disable them.

", - "default": true, - "name": "setting", - "in": "body", - "rawType": "boolean", - "rawDescription": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "childParamsGroups": [] - } - ] - } - ] + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if the repository is archived or if github advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" } ] }, { "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}", + "requestPath": "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances", "serverUrl": "https://api.github.com", "parameters": [ { @@ -31143,65 +39335,112 @@ "descriptionHTML": "" }, { - "name": "check_suite_id", - "description": "check_suite_id parameter", + "name": "alert_number", "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", "required": true, "schema": { - "type": "integer" + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false }, - "descriptionHTML": "

check_suite_id parameter

" + "descriptionHTML": "

The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the number field in the response from the GET /repos/{owner}/{repo}/code-scanning/alerts operation.

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "ref", + "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`." + }, + "descriptionHTML": "

The Git reference for the results you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /repos/{owner}/{repo}/check-suites/{check_suite_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n check_suite_id: 42\n})", - "html": "
await octokit.request('GET /repos/{owner}/{repo}/check-suites/{check_suite_id}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  check_suite_id: 42\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances', {\n owner: 'octocat',\n repo: 'hello-world',\n alert_number: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  alert_number: 42\n})\n
" } ], - "summary": "Get a check suite", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nGets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", + "summary": "List instances of a code scanning alert", + "description": "Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", "tags": [ - "checks" + "code-scanning" ], - "operationId": "checks/get-suite", + "operationId": "code-scanning/list-alerts-instances", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#get-a-check-suite" + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert" }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [], - "category": "checks", - "subcategory": "suites" + "category": "code-scanning", + "subcategory": null }, - "slug": "get-a-check-suite", - "category": "checks", - "categoryLabel": "Checks", - "subcategory": "suites", - "subcategoryLabel": "Suites", + "slug": "list-instances-of-a-code-scanning-alert", + "category": "code-scanning", + "categoryLabel": "Code scanning", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array and a null value for head_branch.

\n

Gets a single check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the repo scope to get check suites in a private repository.

", + "descriptionHTML": "

Lists all instances of the specified code scanning alert. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events read permission to use this endpoint.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"id\": 5,\n  \"node_id\": \"MDEwOkNoZWNrU3VpdGU1\",\n  \"head_branch\": \"master\",\n  \"head_sha\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n  \"status\": \"completed\",\n  \"conclusion\": \"neutral\",\n  \"url\": \"https://api.github.com/repos/github/hello-world/check-suites/5\",\n  \"before\": \"146e867f55c26428e5f9fade55a9bbf5e95a7912\",\n  \"after\": \"d6fde92930d4715a2b49857d24b940956b26d2d3\",\n  \"pull_requests\": [],\n  \"created_at\": \"2017-07-08T16:18:44-04:00\",\n  \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n  \"app\": {\n    \"id\": 1,\n    \"slug\": \"octoapp\",\n    \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n    \"owner\": {\n      \"login\": \"github\",\n      \"id\": 1,\n      \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n      \"url\": \"https://api.github.com/orgs/github\",\n      \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n      \"events_url\": \"https://api.github.com/orgs/github/events\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": true\n    },\n    \"name\": \"Octocat App\",\n    \"description\": \"\",\n    \"external_url\": \"https://example.com\",\n    \"html_url\": \"https://github.com/apps/octoapp\",\n    \"created_at\": \"2017-07-08T16:18:44-04:00\",\n    \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n    \"permissions\": {\n      \"metadata\": \"read\",\n      \"contents\": \"read\",\n      \"issues\": \"write\",\n      \"single_file\": \"write\"\n    },\n    \"events\": [\n      \"push\",\n      \"pull_request\"\n    ]\n  },\n  \"repository\": {\n    \"id\": 1296269,\n    \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n    \"name\": \"Hello-World\",\n    \"full_name\": \"octocat/Hello-World\",\n    \"template_repository\": {\n      \"id\": 1296269,\n      \"node_id\": \"MDEwOlJlcG9zaXRvcnkxMjk2MjY5\",\n      \"name\": \"Hello-World-Template\",\n      \"full_name\": \"octocat/Hello-World-Template\",\n      \"owner\": {\n        \"login\": \"octocat\",\n        \"id\": 1,\n        \"node_id\": \"MDQ6VXNlcjE=\",\n        \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n        \"gravatar_id\": \"\",\n        \"url\": \"https://api.github.com/users/octocat\",\n        \"html_url\": \"https://github.com/octocat\",\n        \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n        \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n        \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n        \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n        \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n        \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n        \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n        \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n        \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n        \"type\": \"User\",\n        \"site_admin\": false\n      },\n      \"private\": false,\n      \"html_url\": \"https://github.com/octocat/Hello-World-Template\",\n      \"description\": \"This your first repo!\",\n      \"fork\": false,\n      \"url\": \"https://api.github.com/repos/octocat/Hello-World-Template\",\n      \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}\",\n      \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}\",\n      \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}\",\n      \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}\",\n      \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}\",\n      \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}\",\n      \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}\",\n      \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}\",\n      \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}\",\n      \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/contributors\",\n      \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/deployments\",\n      \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/downloads\",\n      \"events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/events\",\n      \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/forks\",\n      \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}\",\n      \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}\",\n      \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}\",\n      \"git_url\": \"git:github.com/octocat/Hello-World-Template.git\",\n      \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}\",\n      \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}\",\n      \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}\",\n      \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}\",\n      \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}\",\n      \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/languages\",\n      \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/merges\",\n      \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}\",\n      \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}\",\n      \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}\",\n      \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}\",\n      \"ssh_url\": \"git@github.com:octocat/Hello-World-Template.git\",\n      \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/stargazers\",\n      \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}\",\n      \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscribers\",\n      \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/subscription\",\n      \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/tags\",\n      \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/teams\",\n      \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}\",\n      \"clone_url\": \"https://github.com/octocat/Hello-World-Template.git\",\n      \"mirror_url\": \"git:git.example.com/octocat/Hello-World-Template\",\n      \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World-Template/hooks\",\n      \"svn_url\": \"https://svn.github.com/octocat/Hello-World-Template\",\n      \"homepage\": \"https://github.com\",\n      \"language\": null,\n      \"forks\": 9,\n      \"forks_count\": 9,\n      \"stargazers_count\": 80,\n      \"watchers_count\": 80,\n      \"watchers\": 80,\n      \"size\": 108,\n      \"default_branch\": \"master\",\n      \"open_issues\": 0,\n      \"open_issues_count\": 0,\n      \"is_template\": true,\n      \"license\": {\n        \"key\": \"mit\",\n        \"name\": \"MIT License\",\n        \"url\": \"https://api.github.com/licenses/mit\",\n        \"spdx_id\": \"MIT\",\n        \"node_id\": \"MDc6TGljZW5zZW1pdA==\",\n        \"html_url\": \"https://api.github.com/licenses/mit\"\n      },\n      \"topics\": [\n        \"octocat\",\n        \"atom\",\n        \"electron\",\n        \"api\"\n      ],\n      \"has_issues\": true,\n      \"has_projects\": true,\n      \"has_wiki\": true,\n      \"has_pages\": false,\n      \"has_downloads\": true,\n      \"archived\": false,\n      \"disabled\": false,\n      \"visibility\": \"public\",\n      \"pushed_at\": \"2011-01-26T19:06:43Z\",\n      \"created_at\": \"2011-01-26T19:01:12Z\",\n      \"updated_at\": \"2011-01-26T19:14:43Z\",\n      \"permissions\": {\n        \"admin\": false,\n        \"push\": false,\n        \"pull\": true\n      },\n      \"allow_rebase_merge\": true,\n      \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n      \"allow_squash_merge\": true,\n      \"delete_branch_on_merge\": true,\n      \"allow_merge_commit\": true,\n      \"subscribers_count\": 42,\n      \"network_count\": 0\n    },\n    \"owner\": {\n      \"login\": \"octocat\",\n      \"id\": 1,\n      \"node_id\": \"MDQ6VXNlcjE=\",\n      \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n      \"gravatar_id\": \"\",\n      \"url\": \"https://api.github.com/users/octocat\",\n      \"html_url\": \"https://github.com/octocat\",\n      \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n      \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n      \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n      \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n      \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n      \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n      \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n      \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n      \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n      \"type\": \"User\",\n      \"site_admin\": false\n    },\n    \"private\": false,\n    \"html_url\": \"https://github.com/octocat/Hello-World\",\n    \"description\": \"This your first repo!\",\n    \"fork\": false,\n    \"url\": \"https://api.github.com/repos/octocat/Hello-World\",\n    \"archive_url\": \"https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}\",\n    \"assignees_url\": \"https://api.github.com/repos/octocat/Hello-World/assignees{/user}\",\n    \"blobs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}\",\n    \"branches_url\": \"https://api.github.com/repos/octocat/Hello-World/branches{/branch}\",\n    \"collaborators_url\": \"https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}\",\n    \"comments_url\": \"https://api.github.com/repos/octocat/Hello-World/comments{/number}\",\n    \"commits_url\": \"https://api.github.com/repos/octocat/Hello-World/commits{/sha}\",\n    \"compare_url\": \"https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}\",\n    \"contents_url\": \"https://api.github.com/repos/octocat/Hello-World/contents/{+path}\",\n    \"contributors_url\": \"https://api.github.com/repos/octocat/Hello-World/contributors\",\n    \"deployments_url\": \"https://api.github.com/repos/octocat/Hello-World/deployments\",\n    \"downloads_url\": \"https://api.github.com/repos/octocat/Hello-World/downloads\",\n    \"events_url\": \"https://api.github.com/repos/octocat/Hello-World/events\",\n    \"forks_url\": \"https://api.github.com/repos/octocat/Hello-World/forks\",\n    \"git_commits_url\": \"https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}\",\n    \"git_refs_url\": \"https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}\",\n    \"git_tags_url\": \"https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}\",\n    \"git_url\": \"git:github.com/octocat/Hello-World.git\",\n    \"issue_comment_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}\",\n    \"issue_events_url\": \"https://api.github.com/repos/octocat/Hello-World/issues/events{/number}\",\n    \"issues_url\": \"https://api.github.com/repos/octocat/Hello-World/issues{/number}\",\n    \"keys_url\": \"https://api.github.com/repos/octocat/Hello-World/keys{/key_id}\",\n    \"labels_url\": \"https://api.github.com/repos/octocat/Hello-World/labels{/name}\",\n    \"languages_url\": \"https://api.github.com/repos/octocat/Hello-World/languages\",\n    \"merges_url\": \"https://api.github.com/repos/octocat/Hello-World/merges\",\n    \"milestones_url\": \"https://api.github.com/repos/octocat/Hello-World/milestones{/number}\",\n    \"notifications_url\": \"https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}\",\n    \"pulls_url\": \"https://api.github.com/repos/octocat/Hello-World/pulls{/number}\",\n    \"releases_url\": \"https://api.github.com/repos/octocat/Hello-World/releases{/id}\",\n    \"ssh_url\": \"git@github.com:octocat/Hello-World.git\",\n    \"stargazers_url\": \"https://api.github.com/repos/octocat/Hello-World/stargazers\",\n    \"statuses_url\": \"https://api.github.com/repos/octocat/Hello-World/statuses/{sha}\",\n    \"subscribers_url\": \"https://api.github.com/repos/octocat/Hello-World/subscribers\",\n    \"subscription_url\": \"https://api.github.com/repos/octocat/Hello-World/subscription\",\n    \"tags_url\": \"https://api.github.com/repos/octocat/Hello-World/tags\",\n    \"teams_url\": \"https://api.github.com/repos/octocat/Hello-World/teams\",\n    \"trees_url\": \"https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}\",\n    \"clone_url\": \"https://github.com/octocat/Hello-World.git\",\n    \"mirror_url\": \"git:git.example.com/octocat/Hello-World\",\n    \"hooks_url\": \"https://api.github.com/repos/octocat/Hello-World/hooks\",\n    \"svn_url\": \"https://svn.github.com/octocat/Hello-World\",\n    \"homepage\": \"https://github.com\",\n    \"language\": null,\n    \"forks_count\": 9,\n    \"stargazers_count\": 80,\n    \"watchers_count\": 80,\n    \"size\": 108,\n    \"default_branch\": \"master\",\n    \"open_issues_count\": 0,\n    \"is_template\": false,\n    \"topics\": [\n      \"octocat\",\n      \"atom\",\n      \"electron\",\n      \"api\"\n    ],\n    \"has_issues\": true,\n    \"has_projects\": true,\n    \"has_wiki\": true,\n    \"has_pages\": false,\n    \"has_downloads\": true,\n    \"archived\": false,\n    \"disabled\": false,\n    \"visibility\": \"public\",\n    \"pushed_at\": \"2011-01-26T19:06:43Z\",\n    \"created_at\": \"2011-01-26T19:01:12Z\",\n    \"updated_at\": \"2011-01-26T19:14:43Z\",\n    \"permissions\": {\n      \"admin\": false,\n      \"push\": false,\n      \"pull\": true\n    },\n    \"temp_clone_token\": \"ABTLWHOULUVAXGTRYU7OC2876QJ2O\",\n    \"delete_branch_on_merge\": true,\n    \"subscribers_count\": 42,\n    \"network_count\": 0\n  },\n  \"head_commit\": {\n    \"id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n    \"tree_id\": \"7fd1a60b01f91b314f59955a4e4d4e80d8edf11d\",\n    \"message\": \"Merge pull request #6 from Spaceghost/patch-1\\n\\nNew line at end of file.\",\n    \"timestamp\": \"2016-10-10T00:00:00Z\",\n    \"author\": {\n      \"name\": \"The Octocat\",\n      \"email\": \"octocat@nowhere.com\"\n    },\n    \"committer\": {\n      \"name\": \"The Octocat\",\n      \"email\": \"octocat@nowhere.com\"\n    }\n  },\n  \"latest_check_runs_count\": 1,\n  \"check_runs_url\": \"https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs\"\n}\n
" + "payload": "
[\n  {\n    \"ref\": \"refs/heads/main\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"\",\n    \"state\": \"open\",\n    \"commit_sha\": \"39406e42cb832f683daa691dd652a8dc36ee8930\",\n    \"message\": {\n      \"text\": \"This path depends on a user-provided value.\"\n    },\n    \"location\": {\n      \"path\": \"lib/ab12-gen.js\",\n      \"start_line\": 917,\n      \"end_line\": 917,\n      \"start_column\": 7,\n      \"end_column\": 18\n    },\n    \"classifications\": [\n      \"library\"\n    ]\n  },\n  {\n    \"ref\": \"refs/pull/3740/merge\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:CodeQL-Build\",\n    \"environment\": \"\",\n    \"state\": \"fixed\",\n    \"commit_sha\": \"b09da05606e27f463a2b49287684b4ae777092f2\",\n    \"message\": {\n      \"text\": \"This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1.\"\n    },\n    \"location\": {\n      \"path\": \"app/script.js\",\n      \"start_line\": 2,\n      \"end_line\": 2,\n      \"start_column\": 10,\n      \"end_column\": 50\n    },\n    \"classifications\": [\n      \"source\"\n    ]\n  }\n]\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if github advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" } ] }, { "verb": "get", - "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs", + "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses", "serverUrl": "https://api.github.com", "parameters": [ { @@ -31223,54 +39462,37 @@ "descriptionHTML": "" }, { - "name": "check_suite_id", - "description": "check_suite_id parameter", - "in": "path", - "required": true, - "schema": { - "type": "integer" - }, - "descriptionHTML": "

check_suite_id parameter

" - }, - { - "name": "check_name", - "description": "Returns check runs with the specified `name`.", + "name": "tool_name", + "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", "in": "query", "required": false, "schema": { - "type": "string" + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." }, - "descriptionHTML": "

Returns check runs with the specified name.

" + "descriptionHTML": "

The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either tool_name or tool_guid, but not both.

" }, { - "name": "status", - "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", + "name": "tool_guid", + "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", "in": "query", "required": false, "schema": { + "nullable": true, "type": "string", - "enum": [ - "queued", - "in_progress", - "completed" - ] + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." }, - "descriptionHTML": "

Returns check runs with the specified status. Can be one of queued, in_progress, or completed.

" + "descriptionHTML": "

The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either tool_guid or tool_name, but not both.

" }, { - "name": "filter", - "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", + "name": "page", + "description": "Page number of the results to fetch.", "in": "query", - "required": false, "schema": { - "type": "string", - "enum": [ - "latest", - "all" - ], - "default": "latest" + "type": "integer", + "default": 1 }, - "descriptionHTML": "

Filters check runs by their completed_at timestamp. Can be one of latest (returning the most recent check runs) or all.

" + "descriptionHTML": "

Page number of the results to fetch.

" }, { "name": "per_page", @@ -31283,65 +39505,91 @@ "descriptionHTML": "

Results per page (max 100).

" }, { - "name": "page", - "description": "Page number of the results to fetch.", + "name": "ref", "in": "query", + "description": "The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", + "required": false, "schema": { - "type": "integer", - "default": 1 + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`." }, - "descriptionHTML": "

Page number of the results to fetch.

" + "descriptionHTML": "

The Git reference for the analyses you want to list. The ref for a branch can be formatted either as refs/heads/<branch name> or simply <branch name>. To reference a pull request use refs/pull/<number>/merge.

" + }, + { + "name": "sarif_id", + "in": "query", + "description": "Filter analyses belonging to the same SARIF upload.", + "required": false, + "schema": { + "type": "string", + "description": "An identifier for the upload.", + "example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53", + "nullable": false + }, + "descriptionHTML": "

Filter analyses belonging to the same SARIF upload.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/check-runs", - "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42/check-runs
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/code-scanning/analyses", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/code-scanning/analyses
" }, { "lang": "JavaScript", - "source": "await octokit.request('GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs', {\n owner: 'octocat',\n repo: 'hello-world',\n check_suite_id: 42\n})", - "html": "
await octokit.request('GET /repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  check_suite_id: 42\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/code-scanning/analyses', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/code-scanning/analyses', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" } ], - "summary": "List check runs in a check suite", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", + "summary": "List code scanning analyses for a repository", + "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", + "operationId": "code-scanning/list-recent-analyses", "tags": [ - "checks" + "code-scanning" ], - "operationId": "checks/list-for-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#list-check-runs-in-a-check-suite" + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository" }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "previews": [], - "category": "checks", - "subcategory": "runs" + "category": "code-scanning" }, - "slug": "list-check-runs-in-a-check-suite", - "category": "checks", - "categoryLabel": "Checks", - "subcategory": "runs", - "subcategoryLabel": "Runs", + "slug": "list-code-scanning-analyses-for-a-repository", + "category": "code-scanning", + "categoryLabel": "Code scanning", "notes": [], "bodyParameters": [], - "descriptionHTML": "

Note: The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty pull_requests array.

\n

Lists check runs for a check suite using its id. GitHub Apps must have the checks:read permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the repo scope to get check runs in a private repository.

", + "descriptionHTML": "

Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the page and per_page parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.

\n

The rules_count field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

You must use an access token with the security_events scope to use this endpoint.\nGitHub Apps must have the security_events read permission to use this endpoint.

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

", "responses": [ { "httpStatusCode": "200", "httpStatusMessage": "OK", "description": "Default response", - "payload": "
{\n  \"total_count\": 1,\n  \"check_runs\": [\n    {\n      \"id\": 4,\n      \"head_sha\": \"ce587453ced02b1526dfb4cb910479d431683101\",\n      \"node_id\": \"MDg6Q2hlY2tSdW40\",\n      \"external_id\": \"\",\n      \"url\": \"https://api.github.com/repos/github/hello-world/check-runs/4\",\n      \"html_url\": \"https://github.com/github/hello-world/runs/4\",\n      \"details_url\": \"https://example.com\",\n      \"status\": \"completed\",\n      \"conclusion\": \"neutral\",\n      \"started_at\": \"2018-05-04T01:14:52Z\",\n      \"completed_at\": \"2018-05-04T01:14:52Z\",\n      \"output\": {\n        \"title\": \"Mighty Readme report\",\n        \"summary\": \"There are 0 failures, 2 warnings, and 1 notice.\",\n        \"text\": \"You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.\",\n        \"annotations_count\": 2,\n        \"annotations_url\": \"https://api.github.com/repos/github/hello-world/check-runs/4/annotations\"\n      },\n      \"name\": \"mighty_readme\",\n      \"check_suite\": {\n        \"id\": 5\n      },\n      \"app\": {\n        \"id\": 1,\n        \"slug\": \"octoapp\",\n        \"node_id\": \"MDExOkludGVncmF0aW9uMQ==\",\n        \"owner\": {\n          \"login\": \"github\",\n          \"id\": 1,\n          \"node_id\": \"MDEyOk9yZ2FuaXphdGlvbjE=\",\n          \"url\": \"https://api.github.com/orgs/github\",\n          \"repos_url\": \"https://api.github.com/orgs/github/repos\",\n          \"events_url\": \"https://api.github.com/orgs/github/events\",\n          \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n          \"gravatar_id\": \"\",\n          \"html_url\": \"https://github.com/octocat\",\n          \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n          \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n          \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n          \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n          \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n          \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n          \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n          \"type\": \"User\",\n          \"site_admin\": true\n        },\n        \"name\": \"Octocat App\",\n        \"description\": \"\",\n        \"external_url\": \"https://example.com\",\n        \"html_url\": \"https://github.com/apps/octoapp\",\n        \"created_at\": \"2017-07-08T16:18:44-04:00\",\n        \"updated_at\": \"2017-07-08T16:18:44-04:00\",\n        \"permissions\": {\n          \"metadata\": \"read\",\n          \"contents\": \"read\",\n          \"issues\": \"write\",\n          \"single_file\": \"write\"\n        },\n        \"events\": [\n          \"push\",\n          \"pull_request\"\n        ]\n      },\n      \"pull_requests\": [\n        {\n          \"url\": \"https://api.github.com/repos/github/hello-world/pulls/1\",\n          \"id\": 1934,\n          \"number\": 3956,\n          \"head\": {\n            \"ref\": \"say-hello\",\n            \"sha\": \"3dca65fa3e8d4b3da3f3d056c59aee1c50f41390\",\n            \"repo\": {\n              \"id\": 526,\n              \"url\": \"https://api.github.com/repos/github/hello-world\",\n              \"name\": \"hello-world\"\n            }\n          },\n          \"base\": {\n            \"ref\": \"master\",\n            \"sha\": \"e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f\",\n            \"repo\": {\n              \"id\": 526,\n              \"url\": \"https://api.github.com/repos/github/hello-world\",\n              \"name\": \"hello-world\"\n            }\n          }\n        }\n      ]\n    }\n  ]\n}\n
" + "payload": "
[\n  {\n    \"ref\": \"refs/heads/main\",\n    \"commit_sha\": \"d99612c3e1f2970085cfbaeadf8f010ef69bad83\",\n    \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n    \"environment\": \"{\\\"language\\\":\\\"python\\\"}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-27T15:05:21Z\",\n    \"results_count\": 17,\n    \"rules_count\": 49,\n    \"id\": 201,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n    \"sarif_id\": \"6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53\",\n    \"tool\": {\n      \"name\": \"CodeQL\",\n      \"guid\": null,\n      \"version\": \"2.4.0\"\n    },\n    \"deletable\": true\n  },\n  {\n    \"ref\": \"refs/heads/my-branch\",\n    \"commit_sha\": \"c8cff6510d4d084fb1b4aa13b64b97ca12b07321\",\n    \"analysis_key\": \".github/workflows/shiftleft.yml:build\",\n    \"environment\": \"{}\",\n    \"error\": \"\",\n    \"created_at\": \"2020-08-31T22:46:44Z\",\n    \"results_count\": 17,\n    \"rules_count\": 32,\n    \"id\": 200,\n    \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200\",\n    \"sarif_id\": \"8981cd8e-b078-4ac3-a3be-1dad7dbd0b582\",\n    \"tool\": {\n      \"name\": \"Python Security Analysis\",\n      \"guid\": null,\n      \"version\": \"1.2.0\"\n    },\n    \"deletable\": true\n  }\n]\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if github advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" } ] }, { - "verb": "post", - "requestPath": "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest", + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}", "serverUrl": "https://api.github.com", "parameters": [ { @@ -31363,60 +39611,394 @@ "descriptionHTML": "" }, { - "name": "check_suite_id", - "description": "check_suite_id parameter", + "name": "analysis_id", "in": "path", + "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.", "required": true, "schema": { "type": "integer" }, - "descriptionHTML": "

check_suite_id parameter

" + "descriptionHTML": "

The ID of the analysis, as returned from the GET /repos/{owner}/{repo}/code-scanning/analyses operation.

" } ], "x-codeSamples": [ { "lang": "Shell", - "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/check-suites/42/rerequest", - "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/check-suites/42/rerequest
" + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/42", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/42
" }, { "lang": "JavaScript", - "source": "await octokit.request('POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest', {\n owner: 'octocat',\n repo: 'hello-world',\n check_suite_id: 42\n})", - "html": "
await octokit.request('POST /repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  check_suite_id: 42\n})\n
" + "source": "await octokit.request('GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n analysis_id: 42\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  analysis_id: 42\n})\n
" } ], - "summary": "Rerequest a check suite", - "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.", + "summary": "Get a code scanning analysis for a repository", + "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\nFor an example response, see \"[Custom media type for code scanning](#custom-media-type-for-code-scanning).\"\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", + "operationId": "code-scanning/get-analysis", "tags": [ - "checks" + "code-scanning" ], - "operationId": "checks/rerequest-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#rerequest-a-check-suite" + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository" }, "x-github": { + "enabledForGitHubApps": true, "githubCloudOnly": false, + "previews": [], + "category": "code-scanning" + }, + "slug": "get-a-code-scanning-analysis-for-a-repository", + "category": "code-scanning", + "categoryLabel": "Code scanning", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Gets a specified code scanning analysis for a repository.\nYou must use an access token with the security_events scope to use this endpoint.\nGitHub Apps must have the security_events read permission to use this endpoint.

\n

The default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.

\n

The rules_count field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand 0 is returned in this field.

\n

If you use the Accept header application/sarif+json,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\nSARIF version 2.1.0.\nFor an example response, see \"Custom media type for code scanning.\"

\n

Deprecation notice:\nThe tool_name field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the tool field.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"ref\": \"refs/heads/main\",\n  \"commit_sha\": \"c18c69115654ff0166991962832dc2bd7756e655\",\n  \"analysis_key\": \".github/workflows/codeql-analysis.yml:analyze\",\n  \"environment\": \"{\\\"language\\\":\\\"javascript\\\"}\",\n  \"error\": \"\",\n  \"created_at\": \"2021-01-13T11:55:49Z\",\n  \"results_count\": 3,\n  \"rules_count\": 67,\n  \"id\": 3602840,\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201\",\n  \"sarif_id\": \"47177e22-5596-11eb-80a1-c1e54ef945c6\",\n  \"tool\": {\n    \"name\": \"CodeQL\",\n    \"guid\": null,\n    \"version\": \"2.4.0\"\n  },\n  \"deletable\": true\n}\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if github advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ] + }, + { + "verb": "post", + "requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X POST \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs \\\n -d '{\"commit_sha\":\"commit_sha\",\"ref\":\"ref\",\"sarif\":\"sarif\"}'", + "html": "
curl \\\n  -X POST \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs \\\n  -d '{\"commit_sha\":\"commit_sha\",\"ref\":\"ref\",\"sarif\":\"sarif\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('POST /repos/{owner}/{repo}/code-scanning/sarifs', {\n owner: 'octocat',\n repo: 'hello-world',\n commit_sha: 'commit_sha',\n ref: 'ref',\n sarif: 'sarif'\n})", + "html": "
await octokit.request('POST /repos/{owner}/{repo}/code-scanning/sarifs', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  commit_sha: 'commit_sha',\n  ref: 'ref',\n  sarif: 'sarif'\n})\n
" + } + ], + "summary": "Upload an analysis as SARIF data", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "operationId": "code-scanning/upload-sarif", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#upload-an-analysis-as-sarif-data" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "commit_sha": { + "description": "

Required. The SHA of the commit to which the analysis you are uploading relates.

", + "type": "string", + "minLength": 40, + "maxLength": 40, + "pattern": "^[0-9a-fA-F]+$", + "name": "commit_sha", + "in": "body", + "rawType": "string", + "rawDescription": "The SHA of the commit to which the analysis you are uploading relates.", + "childParamsGroups": [] + }, + "ref": { + "type": "string", + "description": "

Required. The full Git reference, formatted as refs/heads/<branch name>.

", + "name": "ref", + "in": "body", + "rawType": "string", + "rawDescription": "The full Git reference, formatted as `refs/heads/`.", + "childParamsGroups": [] + }, + "sarif": { + "description": "

Required. A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

", + "type": "string", + "name": "sarif", + "in": "body", + "rawType": "string", + "rawDescription": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/github-ae@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning).\"", + "childParamsGroups": [] + }, + "checkout_uri": { + "description": "

The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

", + "example": "file:///github/workspace/", + "type": "string", + "format": "uri", + "name": "checkout_uri", + "in": "body", + "rawType": "string", + "rawDescription": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", + "childParamsGroups": [] + }, + "started_at": { + "description": "

The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "format": "date", + "type": "string", + "name": "started_at", + "in": "body", + "rawType": "string", + "rawDescription": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "childParamsGroups": [] + }, + "tool_name": { + "description": "

The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

", + "type": "string", + "name": "tool_name", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.", + "childParamsGroups": [] + } + }, + "required": [ + "commit_sha", + "ref", + "sarif" + ] + } + } + } + }, + "x-github": { "enabledForGitHubApps": true, + "githubCloudOnly": false, "previews": [], - "category": "checks", - "subcategory": "suites" + "category": "code-scanning" }, - "slug": "rerequest-a-check-suite", - "category": "checks", - "categoryLabel": "Checks", - "subcategory": "suites", - "subcategoryLabel": "Suites", + "slug": "upload-an-analysis-as-sarif-data", + "category": "code-scanning", + "categoryLabel": "Code scanning", "notes": [], + "descriptionHTML": "

Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events write permission to use this endpoint.

\n

You must compress the SARIF-formatted analysis data that you want to upload, using gzip, and then encode it as a Base64 format string. For example:

\n
gzip -c analysis-data.sarif | base64\n
\n

SARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.

\n

The 202 Accepted, response includes an id value.\nYou can use this ID to check the status of the upload by using this for the /sarifs/{sarif_id} endpoint.\nFor more information, see \"Get information about a SARIF upload.\"

", + "bodyParameters": [ + { + "description": "

Required. The SHA of the commit to which the analysis you are uploading relates.

", + "type": "string", + "minLength": 40, + "maxLength": 40, + "pattern": "^[0-9a-fA-F]+$", + "name": "commit_sha", + "in": "body", + "rawType": "string", + "rawDescription": "The SHA of the commit to which the analysis you are uploading relates.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

Required. The full Git reference, formatted as refs/heads/<branch name>.

", + "name": "ref", + "in": "body", + "rawType": "string", + "rawDescription": "The full Git reference, formatted as `refs/heads/`.", + "childParamsGroups": [] + }, + { + "description": "

Required. A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using gzip and then translate the contents of the file into a Base64 encoding string. For more information, see \"SARIF support for code scanning.\"

", + "type": "string", + "name": "sarif", + "in": "body", + "rawType": "string", + "rawDescription": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/github-ae@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning).\"", + "childParamsGroups": [] + }, + { + "description": "

The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.

", + "example": "file:///github/workspace/", + "type": "string", + "format": "uri", + "name": "checkout_uri", + "in": "body", + "rawType": "string", + "rawDescription": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", + "childParamsGroups": [] + }, + { + "description": "

The time that the analysis run began. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.

", + "format": "date", + "type": "string", + "name": "started_at", + "in": "body", + "rawType": "string", + "rawDescription": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "childParamsGroups": [] + }, + { + "description": "

The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the tool_guid parameter of operations such as GET /repos/{owner}/{repo}/code-scanning/alerts.

", + "type": "string", + "name": "tool_name", + "in": "body", + "rawType": "string", + "rawDescription": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.", + "childParamsGroups": [] + } + ], "responses": [ { - "httpStatusCode": "201", - "httpStatusMessage": "Created", - "description": "Response" + "httpStatusCode": "202", + "httpStatusMessage": "Accepted", + "description": "Default response", + "payload": "
{\n  \"id\": \"47177e22-5596-11eb-80a1-c1e54ef945c6\",\n  \"url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6\"\n}\n
" + }, + { + "httpStatusCode": "400", + "httpStatusMessage": "Bad Request", + "description": "Response if the sarif field is invalid" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if the repository is archived or if github advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Resource not found" + }, + { + "httpStatusCode": "413", + "httpStatusMessage": "Payload Too Large", + "description": "Response if the sarif field is too large" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "sarif_id", + "description": "The SARIF ID obtained after uploading.", + "in": "path", + "schema": { + "type": "string" + }, + "required": true, + "descriptionHTML": "

The SARIF ID obtained after uploading.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/SARIF_ID", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/SARIF_ID
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}', {\n owner: 'octocat',\n repo: 'hello-world',\n sarif_id: 'sarif_id'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  sarif_id: 'sarif_id'\n})\n
" } ], + "summary": "Get information about a SARIF upload", + "description": "Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository).\" You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", + "operationId": "code-scanning/get-sarif", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#get-information-about-a-sarif-upload" + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [], + "category": "code-scanning" + }, + "slug": "get-information-about-a-sarif-upload", + "category": "code-scanning", + "categoryLabel": "Code scanning", + "notes": [], "bodyParameters": [], - "descriptionHTML": "

Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the check_suite webhook event with the action rerequested. When a check suite is rerequested, its status is reset to queued and the conclusion is cleared.

\n

To rerequest a check suite, your GitHub App must have the checks:read permission on a private repository or pull access to a public repository.

" + "descriptionHTML": "

Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"Get a code scanning analysis for a repository.\" You must use an access token with the security_events scope to use this endpoint. GitHub Apps must have the security_events read permission to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"processing_status\": \"complete\",\n  \"analyses_url\": \"https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6\"\n}\n
" + }, + { + "httpStatusCode": "403", + "httpStatusMessage": "Forbidden", + "description": "Response if github advanced security is not enabled for this repository" + }, + { + "httpStatusCode": "404", + "httpStatusMessage": "Not Found", + "description": "Response if the sarif id does not match any upload" + }, + { + "httpStatusCode": "503", + "httpStatusMessage": "Service Unavailable", + "description": "Service unavailable" + } + ] }, { "verb": "get", @@ -36375,6 +44957,616 @@ } ] }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/environments", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/environments
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/environments', {\n owner: 'octocat',\n repo: 'hello-world'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/environments', {\n  owner: 'octocat',\n  repo: 'hello-world'\n})\n
" + } + ], + "summary": "Get all environments", + "description": "Get all environments for a repository.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/get-all-environments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#get-all-environments" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "environments" + }, + "slug": "get-all-environments", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "environments", + "subcategoryLabel": "Environments", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Get all environments for a repository.

\n

Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"total_count\": 1,\n  \"environments\": [\n    {\n      \"id\": 161088068,\n      \"node_id\": \"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\n      \"name\": \"staging\",\n      \"url\": \"https://api.github.com/repos/github/hello-world/environments/staging\",\n      \"html_url\": \"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\n      \"created_at\": \"2020-11-23T22:00:40Z\",\n      \"updated_at\": \"2020-11-23T22:00:40Z\",\n      \"protection_rules\": [\n        {\n          \"id\": 3736,\n          \"node_id\": \"MDQ6R2F0ZTM3MzY=\",\n          \"type\": \"wait_timer\",\n          \"wait_timer\": 30\n        },\n        {\n          \"id\": 3755,\n          \"node_id\": \"MDQ6R2F0ZTM3NTU=\",\n          \"type\": \"required_reviewers\",\n          \"reviewers\": [\n            {\n              \"type\": \"User\",\n              \"reviewer\": {\n                \"login\": \"octocat\",\n                \"id\": 1,\n                \"node_id\": \"MDQ6VXNlcjE=\",\n                \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n                \"gravatar_id\": \"\",\n                \"url\": \"https://api.github.com/users/octocat\",\n                \"html_url\": \"https://github.com/octocat\",\n                \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n                \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n                \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n                \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n                \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n                \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n                \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n                \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n                \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n                \"type\": \"User\",\n                \"site_admin\": false\n              }\n            },\n            {\n              \"type\": \"Team\",\n              \"reviewer\": {\n                \"id\": 1,\n                \"node_id\": \"MDQ6VGVhbTE=\",\n                \"url\": \"https://api.github.com/teams/1\",\n                \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n                \"name\": \"Justice League\",\n                \"slug\": \"justice-league\",\n                \"description\": \"A great team.\",\n                \"privacy\": \"closed\",\n                \"permission\": \"admin\",\n                \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n                \"repositories_url\": \"https://api.github.com/teams/1/repos\"\n              }\n            }\n          ]\n        },\n        {\n          \"id\": 3756,\n          \"node_id\": \"MDQ6R2F0ZTM3NTY=\",\n          \"type\": \"branch_policy\"\n        }\n      ],\n      \"deployment_branch_policy\": {\n        \"protected_branches\": false,\n        \"custom_branch_policies\": true\n      }\n    }\n  ]\n}\n
" + } + ] + }, + { + "verb": "get", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + }, + "descriptionHTML": "

The name of the environment

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/environments/ENVIRONMENT_NAME", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/environments/ENVIRONMENT_NAME
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repos/{owner}/{repo}/environments/{environment_name}', {\n owner: 'octocat',\n repo: 'hello-world',\n environment_name: 'environment_name'\n})", + "html": "
await octokit.request('GET /repos/{owner}/{repo}/environments/{environment_name}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  environment_name: 'environment_name'\n})\n
" + } + ], + "summary": "Get an environment", + "description": "Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/get-environment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#get-an-environment" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "environments" + }, + "slug": "get-an-environment", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "environments", + "subcategoryLabel": "Environments", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the repo scope. GitHub Apps must have the actions:read permission to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"id\": 161088068,\n  \"node_id\": \"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\n  \"name\": \"staging\",\n  \"url\": \"https://api.github.com/repos/github/hello-world/environments/staging\",\n  \"html_url\": \"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\n  \"created_at\": \"2020-11-23T22:00:40Z\",\n  \"updated_at\": \"2020-11-23T22:00:40Z\",\n  \"protection_rules\": [\n    {\n      \"id\": 3736,\n      \"node_id\": \"MDQ6R2F0ZTM3MzY=\",\n      \"type\": \"wait_timer\",\n      \"wait_timer\": 30\n    },\n    {\n      \"id\": 3755,\n      \"node_id\": \"MDQ6R2F0ZTM3NTU=\",\n      \"type\": \"required_reviewers\",\n      \"reviewers\": [\n        {\n          \"type\": \"User\",\n          \"reviewer\": {\n            \"login\": \"octocat\",\n            \"id\": 1,\n            \"node_id\": \"MDQ6VXNlcjE=\",\n            \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n            \"gravatar_id\": \"\",\n            \"url\": \"https://api.github.com/users/octocat\",\n            \"html_url\": \"https://github.com/octocat\",\n            \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n            \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n            \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n            \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n            \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n            \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n            \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n            \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n            \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n            \"type\": \"User\",\n            \"site_admin\": false\n          }\n        },\n        {\n          \"type\": \"Team\",\n          \"reviewer\": {\n            \"id\": 1,\n            \"node_id\": \"MDQ6VGVhbTE=\",\n            \"url\": \"https://api.github.com/teams/1\",\n            \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n            \"name\": \"Justice League\",\n            \"slug\": \"justice-league\",\n            \"description\": \"A great team.\",\n            \"privacy\": \"closed\",\n            \"permission\": \"admin\",\n            \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n            \"repositories_url\": \"https://api.github.com/teams/1/repos\"\n          }\n        }\n      ]\n    },\n    {\n      \"id\": 3756,\n      \"node_id\": \"MDQ6R2F0ZTM3NTY=\",\n      \"type\": \"branch_policy\"\n    }\n  ],\n  \"deployment_branch_policy\": {\n    \"protected_branches\": false,\n    \"custom_branch_policies\": true\n  }\n}\n
" + } + ] + }, + { + "verb": "put", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + }, + "descriptionHTML": "

The name of the environment

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/environments/ENVIRONMENT_NAME \\\n -d '{\"wait_timer\":42}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/environments/ENVIRONMENT_NAME \\\n  -d '{\"wait_timer\":42}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /repos/{owner}/{repo}/environments/{environment_name}', {\n owner: 'octocat',\n repo: 'hello-world',\n environment_name: 'environment_name',\n wait_timer: 42\n})", + "html": "
await octokit.request('PUT /repos/{owner}/{repo}/environments/{environment_name}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  environment_name: 'environment_name',\n  wait_timer: 42\n})\n
" + } + ], + "summary": "Create or update an environment", + "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"[Environments](/actions/reference/environments#deployment-branches).\"\n\n**Note:** To create or update secrets for an environment, see \"[Secrets](/rest/reference/actions#secrets).\"\n\nYou must authenticate using an access token with the repo scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-or-update-environment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#create-or-update-an-environment" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "wait_timer": { + "type": "integer", + "example": 30, + "description": "

The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).

", + "name": "wait_timer", + "in": "body", + "rawType": "integer", + "rawDescription": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).", + "childParamsGroups": [] + }, + "reviewers": { + "type": "array of objects or null", + "nullable": true, + "description": "

The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "

The type of reviewer. Must be one of: User or Team

", + "enum": [ + "User", + "Team" + ], + "example": "User", + "name": "type", + "in": "body", + "rawType": "string", + "rawDescription": "The type of reviewer. Must be one of: `User` or `Team`", + "childParamsGroups": [] + }, + "id": { + "type": "integer", + "description": "

The id of the user or team who can review the deployment

", + "example": 4532992, + "name": "id", + "in": "body", + "rawType": "integer", + "rawDescription": "The id of the user or team who can review the deployment", + "childParamsGroups": [] + } + } + }, + "name": "reviewers", + "in": "body", + "rawType": "array", + "rawDescription": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "childParamsGroups": [ + { + "parentName": "reviewers", + "parentType": "items", + "id": "reviewers-items", + "params": [ + { + "type": "string", + "description": "

The type of reviewer. Must be one of: User or Team

", + "enum": [ + "User", + "Team" + ], + "example": "User", + "name": "type", + "in": "body", + "rawType": "string", + "rawDescription": "The type of reviewer. Must be one of: `User` or `Team`", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The id of the user or team who can review the deployment

", + "example": 4532992, + "name": "id", + "in": "body", + "rawType": "integer", + "rawDescription": "The id of the user or team who can review the deployment", + "childParamsGroups": [] + } + ] + } + ] + }, + "deployment_branch_policy": { + "type": "object or null", + "description": "

The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

", + "properties": { + "protected_branches": { + "type": "boolean", + "description": "

Required. Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

", + "name": "protected_branches", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", + "childParamsGroups": [] + }, + "custom_branch_policies": { + "type": "boolean", + "description": "

Required. Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

", + "name": "custom_branch_policies", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", + "childParamsGroups": [] + } + }, + "nullable": true, + "required": [ + "protected_branches", + "custom_branch_policies" + ], + "name": "deployment_branch_policy", + "in": "body", + "rawType": "object", + "rawDescription": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", + "childParamsGroups": [ + { + "parentName": "deployment_branch_policy", + "parentType": "object", + "id": "deployment_branch_policy-object", + "params": [ + { + "type": "boolean", + "description": "

Required. Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

", + "name": "protected_branches", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Required. Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

", + "name": "custom_branch_policies", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", + "childParamsGroups": [] + } + ] + } + ] + } + }, + "additionalProperties": false + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "environments" + }, + "slug": "create-or-update-an-environment", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "environments", + "subcategoryLabel": "Environments", + "notes": [], + "descriptionHTML": "

Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"Environments.\"

\n

Note: Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"Environments.\"

\n

Note: To create or update secrets for an environment, see \"Secrets.\"

\n

You must authenticate using an access token with the repo scope to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"id\": 161088068,\n  \"node_id\": \"MDExOkVudmlyb25tZW50MTYxMDg4MDY4\",\n  \"name\": \"staging\",\n  \"url\": \"https://api.github.com/repos/github/hello-world/environments/staging\",\n  \"html_url\": \"https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging\",\n  \"created_at\": \"2020-11-23T22:00:40Z\",\n  \"updated_at\": \"2020-11-23T22:00:40Z\",\n  \"protection_rules\": [\n    {\n      \"id\": 3736,\n      \"node_id\": \"MDQ6R2F0ZTM3MzY=\",\n      \"type\": \"wait_timer\",\n      \"wait_timer\": 30\n    },\n    {\n      \"id\": 3755,\n      \"node_id\": \"MDQ6R2F0ZTM3NTU=\",\n      \"type\": \"required_reviewers\",\n      \"reviewers\": [\n        {\n          \"type\": \"User\",\n          \"reviewer\": {\n            \"login\": \"octocat\",\n            \"id\": 1,\n            \"node_id\": \"MDQ6VXNlcjE=\",\n            \"avatar_url\": \"https://github.com/images/error/octocat_happy.gif\",\n            \"gravatar_id\": \"\",\n            \"url\": \"https://api.github.com/users/octocat\",\n            \"html_url\": \"https://github.com/octocat\",\n            \"followers_url\": \"https://api.github.com/users/octocat/followers\",\n            \"following_url\": \"https://api.github.com/users/octocat/following{/other_user}\",\n            \"gists_url\": \"https://api.github.com/users/octocat/gists{/gist_id}\",\n            \"starred_url\": \"https://api.github.com/users/octocat/starred{/owner}{/repo}\",\n            \"subscriptions_url\": \"https://api.github.com/users/octocat/subscriptions\",\n            \"organizations_url\": \"https://api.github.com/users/octocat/orgs\",\n            \"repos_url\": \"https://api.github.com/users/octocat/repos\",\n            \"events_url\": \"https://api.github.com/users/octocat/events{/privacy}\",\n            \"received_events_url\": \"https://api.github.com/users/octocat/received_events\",\n            \"type\": \"User\",\n            \"site_admin\": false\n          }\n        },\n        {\n          \"type\": \"Team\",\n          \"reviewer\": {\n            \"id\": 1,\n            \"node_id\": \"MDQ6VGVhbTE=\",\n            \"url\": \"https://api.github.com/teams/1\",\n            \"html_url\": \"https://github.com/orgs/github/teams/justice-league\",\n            \"name\": \"Justice League\",\n            \"slug\": \"justice-league\",\n            \"description\": \"A great team.\",\n            \"privacy\": \"closed\",\n            \"permission\": \"admin\",\n            \"members_url\": \"https://api.github.com/teams/1/members{/member}\",\n            \"repositories_url\": \"https://api.github.com/teams/1/repos\"\n          }\n        }\n      ]\n    },\n    {\n      \"id\": 3756,\n      \"node_id\": \"MDQ6R2F0ZTM3NTY=\",\n      \"type\": \"branch_policy\"\n    }\n  ],\n  \"deployment_branch_policy\": {\n    \"protected_branches\": false,\n    \"custom_branch_policies\": true\n  }\n}\n
" + }, + { + "httpStatusCode": "422", + "httpStatusMessage": "Unprocessable Entity", + "description": "Validation error when the environment name is invalid or when protected branches and custom branch policies in deployment branch policy are set to the same value" + } + ], + "bodyParameters": [ + { + "type": "integer", + "example": 30, + "description": "

The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).

", + "name": "wait_timer", + "in": "body", + "rawType": "integer", + "rawDescription": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days).", + "childParamsGroups": [] + }, + { + "type": "array of objects or null", + "nullable": true, + "description": "

The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.

", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "

The type of reviewer. Must be one of: User or Team

", + "enum": [ + "User", + "Team" + ], + "example": "User", + "name": "type", + "in": "body", + "rawType": "string", + "rawDescription": "The type of reviewer. Must be one of: `User` or `Team`", + "childParamsGroups": [] + }, + "id": { + "type": "integer", + "description": "

The id of the user or team who can review the deployment

", + "example": 4532992, + "name": "id", + "in": "body", + "rawType": "integer", + "rawDescription": "The id of the user or team who can review the deployment", + "childParamsGroups": [] + } + } + }, + "name": "reviewers", + "in": "body", + "rawType": "array", + "rawDescription": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "childParamsGroups": [ + { + "parentName": "reviewers", + "parentType": "items", + "id": "reviewers-items", + "params": [ + { + "type": "string", + "description": "

The type of reviewer. Must be one of: User or Team

", + "enum": [ + "User", + "Team" + ], + "example": "User", + "name": "type", + "in": "body", + "rawType": "string", + "rawDescription": "The type of reviewer. Must be one of: `User` or `Team`", + "childParamsGroups": [] + }, + { + "type": "integer", + "description": "

The id of the user or team who can review the deployment

", + "example": 4532992, + "name": "id", + "in": "body", + "rawType": "integer", + "rawDescription": "The id of the user or team who can review the deployment", + "childParamsGroups": [] + } + ] + } + ] + }, + { + "type": "object or null", + "description": "

The type of deployment branch policy for this environment. To allow all branches to deploy, set to null.

", + "properties": { + "protected_branches": { + "type": "boolean", + "description": "

Required. Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

", + "name": "protected_branches", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", + "childParamsGroups": [] + }, + "custom_branch_policies": { + "type": "boolean", + "description": "

Required. Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

", + "name": "custom_branch_policies", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", + "childParamsGroups": [] + } + }, + "nullable": true, + "required": [ + "protected_branches", + "custom_branch_policies" + ], + "name": "deployment_branch_policy", + "in": "body", + "rawType": "object", + "rawDescription": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", + "childParamsGroups": [ + { + "parentName": "deployment_branch_policy", + "parentType": "object", + "id": "deployment_branch_policy-object", + "params": [ + { + "type": "boolean", + "description": "

Required. Whether only branches with branch protection rules can deploy to this environment. If protected_branches is true, custom_branch_policies must be false; if protected_branches is false, custom_branch_policies must be true.

", + "name": "protected_branches", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`.", + "childParamsGroups": [] + }, + { + "type": "boolean", + "description": "

Required. Whether only branches that match the specified name patterns can deploy to this environment. If custom_branch_policies is true, protected_branches must be false; if custom_branch_policies is false, protected_branches must be true.

", + "name": "custom_branch_policies", + "in": "body", + "rawType": "boolean", + "rawDescription": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`.", + "childParamsGroups": [] + } + ] + } + ] + } + ] + }, + { + "verb": "delete", + "requestPath": "/repos/{owner}/{repo}/environments/{environment_name}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "" + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + }, + "descriptionHTML": "

The name of the environment

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repos/octocat/hello-world/environments/ENVIRONMENT_NAME", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repos/octocat/hello-world/environments/ENVIRONMENT_NAME
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /repos/{owner}/{repo}/environments/{environment_name}', {\n owner: 'octocat',\n repo: 'hello-world',\n environment_name: 'environment_name'\n})", + "html": "
await octokit.request('DELETE /repos/{owner}/{repo}/environments/{environment_name}', {\n  owner: 'octocat',\n  repo: 'hello-world',\n  environment_name: 'environment_name'\n})\n
" + } + ], + "summary": "Delete an environment", + "description": "You must authenticate using an access token with the repo scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-an-environment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#delete-an-environment" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "repos", + "subcategory": "environments" + }, + "slug": "delete-an-environment", + "category": "repos", + "categoryLabel": "Repos", + "subcategory": "environments", + "subcategoryLabel": "Environments", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

You must authenticate using an access token with the repo scope to use this endpoint.

" + }, { "verb": "get", "requestPath": "/repos/{owner}/{repo}/events", @@ -56491,6 +65683,468 @@ } ] }, + { + "verb": "get", + "requestPath": "/repositories/{repository_id}/environments/{environment_name}/secrets", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + }, + "descriptionHTML": "

The name of the environment

" + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + }, + "descriptionHTML": "

Results per page (max 100).

" + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + }, + "descriptionHTML": "

Page number of the results to fetch.

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repositories/42/environments/ENVIRONMENT_NAME/secrets", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repositories/42/environments/ENVIRONMENT_NAME/secrets
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repositories/{repository_id}/environments/{environment_name}/secrets', {\n repository_id: 42,\n environment_name: 'environment_name'\n})", + "html": "
await octokit.request('GET /repositories/{repository_id}/environments/{environment_name}/secrets', {\n  repository_id: 42,\n  environment_name: 'environment_name'\n})\n
" + } + ], + "summary": "List environment secrets", + "description": "Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-environment-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-environment-secrets" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "list-environment-secrets", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"total_count\": 2,\n  \"secrets\": [\n    {\n      \"name\": \"GH_TOKEN\",\n      \"created_at\": \"2019-08-10T14:59:22Z\",\n      \"updated_at\": \"2020-01-10T14:59:22Z\"\n    },\n    {\n      \"name\": \"GIST_ID\",\n      \"created_at\": \"2020-01-10T10:59:22Z\",\n      \"updated_at\": \"2020-01-11T11:59:22Z\"\n    }\n  ]\n}\n
" + } + ] + }, + { + "verb": "get", + "requestPath": "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + }, + "descriptionHTML": "

The name of the environment

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repositories/42/environments/ENVIRONMENT_NAME/secrets/public-key", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repositories/42/environments/ENVIRONMENT_NAME/secrets/public-key
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key', {\n repository_id: 42,\n environment_name: 'environment_name'\n})", + "html": "
await octokit.request('GET /repositories/{repository_id}/environments/{environment_name}/secrets/public-key', {\n  repository_id: 42,\n  environment_name: 'environment_name'\n})\n
" + } + ], + "summary": "Get an environment public key", + "description": "Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-environment-public-key" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "get-an-environment-public-key", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the repo scope. GitHub Apps must have the secrets repository permission to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"key_id\": \"012345678912345678\",\n  \"key\": \"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234\"\n}\n
" + } + ] + }, + { + "verb": "get", + "requestPath": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + }, + "descriptionHTML": "

The name of the environment

" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

secret_name parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repositories/42/environments/ENVIRONMENT_NAME/secrets/SECRET_NAME", + "html": "
curl \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repositories/42/environments/ENVIRONMENT_NAME/secrets/SECRET_NAME
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}', {\n repository_id: 42,\n environment_name: 'environment_name',\n secret_name: 'secret_name'\n})", + "html": "
await octokit.request('GET /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}', {\n  repository_id: 42,\n  environment_name: 'environment_name',\n  secret_name: 'secret_name'\n})\n
" + } + ], + "summary": "Get an environment secret", + "description": "Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-environment-secret" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "get-an-environment-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "bodyParameters": [], + "descriptionHTML": "

Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.

", + "responses": [ + { + "httpStatusCode": "200", + "httpStatusMessage": "OK", + "description": "Default response", + "payload": "
{\n  \"name\": \"GH_TOKEN\",\n  \"created_at\": \"2019-08-10T14:59:22Z\",\n  \"updated_at\": \"2020-01-10T14:59:22Z\"\n}\n
" + } + ] + }, + { + "verb": "put", + "requestPath": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + }, + "descriptionHTML": "

The name of the environment

" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

secret_name parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X PUT \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repositories/42/environments/ENVIRONMENT_NAME/secrets/SECRET_NAME \\\n -d '{\"encrypted_value\":\"encrypted_value\"}'", + "html": "
curl \\\n  -X PUT \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repositories/42/environments/ENVIRONMENT_NAME/secrets/SECRET_NAME \\\n  -d '{\"encrypted_value\":\"encrypted_value\"}'
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}', {\n repository_id: 42,\n environment_name: 'environment_name',\n secret_name: 'secret_name',\n encrypted_value: 'encrypted_value'\n})", + "html": "
await octokit.request('PUT /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}', {\n  repository_id: 42,\n  environment_name: 'environment_name',\n  secret_name: 'secret_name',\n  encrypted_value: 'encrypted_value'\n})\n
" + } + ], + "summary": "Create or update an environment secret", + "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "tags": [ + "actions" + ], + "operationId": "actions/create-or-update-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-environment-secret" + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", + "name": "encrypted_value", + "in": "body", + "rawType": "string", + "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-environment-public-key) endpoint.", + "childParamsGroups": [] + }, + "key_id": { + "type": "string", + "description": "

ID of the key you used to encrypt the secret.

", + "name": "key_id", + "in": "body", + "rawType": "string", + "rawDescription": "ID of the key you used to encrypt the secret.", + "childParamsGroups": [] + } + } + }, + "example": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "create-or-update-an-environment-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "responses": [ + { + "httpStatusCode": "201", + "httpStatusMessage": "Created", + "description": "Response when creating a secret" + }, + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Response when updating a secret" + } + ], + "descriptionHTML": "

Creates or updates an environment secret with an encrypted value. Encrypt your secret using\nLibSodium. You must authenticate using an access\ntoken with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use\nthis endpoint.

\n

Example encrypting a secret using Node.js

\n

Encrypt your secret using the tweetsodium library.

\n
const sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n
\n

Example encrypting a secret using Python

\n

Encrypt your secret using pynacl with Python 3.

\n
from base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n  \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n  public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n  sealed_box = public.SealedBox(public_key)\n  encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n  return b64encode(encrypted).decode(\"utf-8\")\n
\n

Example encrypting a secret using C#

\n

Encrypt your secret using the Sodium.Core package.

\n
var secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n
\n

Example encrypting a secret using Ruby

\n

Encrypt your secret using the rbnacl gem.

\n
require \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n
", + "bodyParameters": [ + { + "type": "string", + "description": "

Value for your secret, encrypted with LibSodium using the public key retrieved from the Get an environment public key endpoint.

", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$", + "name": "encrypted_value", + "in": "body", + "rawType": "string", + "rawDescription": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-environment-public-key) endpoint.", + "childParamsGroups": [] + }, + { + "type": "string", + "description": "

ID of the key you used to encrypt the secret.

", + "name": "key_id", + "in": "body", + "rawType": "string", + "rawDescription": "ID of the key you used to encrypt the secret.", + "childParamsGroups": [] + } + ] + }, + { + "verb": "delete", + "requestPath": "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}", + "serverUrl": "https://api.github.com", + "parameters": [ + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + }, + "descriptionHTML": "" + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + }, + "descriptionHTML": "

The name of the environment

" + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + }, + "descriptionHTML": "

secret_name parameter

" + } + ], + "x-codeSamples": [ + { + "lang": "Shell", + "source": "curl \\\n -X DELETE \\\n -H \"Accept: application/vnd.github.v3+json\" \\\n https://api.github.com/repositories/42/environments/ENVIRONMENT_NAME/secrets/SECRET_NAME", + "html": "
curl \\\n  -X DELETE \\\n  -H \"Accept: application/vnd.github.v3+json\" \\\n  https://api.github.com/repositories/42/environments/ENVIRONMENT_NAME/secrets/SECRET_NAME
" + }, + { + "lang": "JavaScript", + "source": "await octokit.request('DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}', {\n repository_id: 42,\n environment_name: 'environment_name',\n secret_name: 'secret_name'\n})", + "html": "
await octokit.request('DELETE /repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}', {\n  repository_id: 42,\n  environment_name: 'environment_name',\n  secret_name: 'secret_name'\n})\n
" + } + ], + "summary": "Delete an environment secret", + "description": "Deletes a secret in an environment using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-an-environment-secret" + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [], + "category": "actions", + "subcategory": "secrets" + }, + "slug": "delete-an-environment-secret", + "category": "actions", + "categoryLabel": "Actions", + "subcategory": "secrets", + "subcategoryLabel": "Secrets", + "notes": [], + "responses": [ + { + "httpStatusCode": "204", + "httpStatusMessage": "No Content", + "description": "Default Response" + } + ], + "bodyParameters": [], + "descriptionHTML": "

Deletes a secret in an environment using the secret name. You must authenticate using an access token with the repo scope to use this endpoint. GitHub Apps must have the secrets repository permission to use this endpoint.

" + }, { "verb": "get", "requestPath": "/search/code", diff --git a/lib/rest/static/dereferenced/api.github.com.deref.json b/lib/rest/static/dereferenced/api.github.com.deref.json index cff15a6e6473..290e985a8269 100644 --- a/lib/rest/static/dereferenced/api.github.com.deref.json +++ b/lib/rest/static/dereferenced/api.github.com.deref.json @@ -6739,7 +6739,10 @@ "type": "string", "description": "The OAuth access token used to authenticate to the GitHub API." } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -6877,7 +6880,7 @@ "type": "integer" }, "repositories": { - "description": "The list of repository IDs to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", + "description": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", "type": "array", "items": { "type": "string", @@ -6885,7 +6888,7 @@ } }, "repository_ids": { - "description": "The list of repository names to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", + "description": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", "example": [ 1 ], @@ -7146,7 +7149,10 @@ "single_file": "read" } } - } + }, + "required": [ + "access_token" + ] } } } @@ -52790,7 +52796,8 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint." + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/rest/reference/actions#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { "type": "string", @@ -52815,7 +52822,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "visibility": "selected", "selected_repository_ids": [ @@ -77174,7 +77181,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -78996,7 +79003,7 @@ }, "post": { "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -79035,12 +79042,12 @@ }, "private": { "type": "boolean", - "description": "Either `true` to create a private repository or `false` to create a public one.", + "description": "Whether the repository is private.", "default": false }, "visibility": { "type": "string", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "enum": [ "public", "private", @@ -121715,7 +121722,8 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/actions#get-a-repository-public-key) endpoint." + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/rest/reference/actions#get-a-repository-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { "type": "string", @@ -121724,7 +121732,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" } } @@ -139701,7 +139709,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -139711,6 +139719,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -179933,450 +179942,16 @@ "subcategory": "environments" } }, - "post": { - "summary": "Create an environment", - "description": "Create an environment for a repository. If an environment with the specified name already exists, the existing environment will be returned.\n\nThe created environment will not have any protection rules configured. To configure protection rules for the created environment, see \"[Set protection rules for an environment](#set-protection-rules-for-an-environment)\".\n\nYou must authenticate using an access token with the repo scope to use this endpoint.", - "tags": [ - "repos" - ], - "operationId": "repos/create-an-environment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#create-an-environment" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "environment_name", - "in": "path", - "required": true, - "description": "The name of the environment", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "Environment", - "description": "Details of a deployment environment", - "type": "object", - "properties": { - "id": { - "description": "The id of the environment.", - "example": 56780428, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=" - }, - "name": { - "description": "The name of the environment.", - "example": "staging", - "type": "string" - }, - "url": { - "type": "string", - "example": "https://api.github.com/repos/github/hello-world/environments/staging" - }, - "html_url": { - "type": "string", - "example": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" - }, - "created_at": { - "description": "The time that the environment was created, in ISO 8601 format.", - "example": "2020-11-23T22:00:40Z", - "format": "date-time", - "type": "string" - }, - "updated_at": { - "description": "The time that the environment was last updated, in ISO 8601 format.", - "example": "2020-11-23T22:00:40Z", - "format": "date-time", - "type": "string" - }, - "protection_rules": { - "type": "array", - "items": { - "anyOf": [ - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 3515 - }, - "node_id": { - "type": "string", - "example": "MDQ6R2F0ZTM1MTU=" - }, - "type": { - "type": "string", - "example": "wait_timer" - }, - "wait_timer": { - "type": "integer", - "example": 30, - "description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days)." - } - }, - "required": [ - "id", - "node_id", - "type" - ] - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 3755 - }, - "node_id": { - "type": "string", - "example": "MDQ6R2F0ZTM3NTU=" - }, - "type": { - "type": "string", - "example": "required_reviewers" - }, - "reviewers": { - "type": "array", - "description": "The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", - "items": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "The type of reviewer. Must be one of: `User` or `Team`", - "enum": [ - "User", - "Team" - ], - "example": "User" - }, - "reviewer": { - "anyOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } - ] - } - } - } - } - }, - "required": [ - "id", - "node_id", - "type" - ] - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 3515 - }, - "node_id": { - "type": "string", - "example": "MDQ6R2F0ZTM1MTU=" - }, - "type": { - "type": "string", - "example": "branch_policy" - } - }, - "required": [ - "id", - "node_id", - "type" - ] - } - ] - } - }, - "deployment_branch_policy": { - "type": "object", - "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", - "properties": { - "protected_branches": { - "type": "boolean", - "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`." - }, - "custom_branch_policies": { - "type": "boolean", - "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`." - } - }, - "nullable": true, - "required": [ - "protected_branches", - "custom_branch_policies" - ] - } - }, - "required": [ - "id", - "node_id", - "name", - "url", - "html_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 161088068, - "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", - "name": "staging", - "url": "https://api.github.com/repos/github/hello-world/environments/staging", - "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging", - "created_at": "2020-11-23T22:00:40Z", - "updated_at": "2020-11-23T22:00:40Z", - "protection_rules": [ - - ], - "deployment_branch_policy": null - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - - ], - "category": "repos", - "subcategory": "environments" - } - }, "put": { - "summary": "Set protection rules for an environment", - "description": "Set protection rules, such as required reviewers, for an environment. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"[Environments](/actions/reference/environments#deployment-branches).\"\n\nYou must authenticate using an access token with the repo scope to use this endpoint.", + "summary": "Create or update an environment", + "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"[Environments](/actions/reference/environments#deployment-branches).\"\n\n**Note:** To create or update secrets for an environment, see \"[Secrets](/rest/reference/actions#secrets).\"\n\nYou must authenticate using an access token with the repo scope to use this endpoint.", "tags": [ "repos" ], - "operationId": "repos/set-environment-protection-rules", + "operationId": "repos/create-or-update-environment", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/rest/reference/repos#set-protection-rules-for-an-environment" + "url": "https://docs.github.com/rest/reference/repos#create-or-update-an-environment" }, "parameters": [ { @@ -180410,6 +179985,7 @@ "application/json": { "schema": { "type": "object", + "nullable": true, "properties": { "wait_timer": { "type": "integer", @@ -180418,7 +179994,8 @@ }, "reviewers": { "type": "array", - "description": "The people or teams that may jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "nullable": true, + "description": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", "items": { "type": "object", "properties": { @@ -180458,7 +180035,8 @@ "custom_branch_policies" ] } - } + }, + "additionalProperties": false } } } @@ -180908,7 +180486,7 @@ } }, "422": { - "description": "Response when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value", + "description": "Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value", "content": { "application/json": { "schema": { @@ -274060,7 +273638,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -275246,7 +274824,7 @@ "/repositories": { "get": { "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -277303,7 +276881,8 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/reference/actions#get-an-environment-public-key) endpoint." + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/rest/reference/actions#get-an-environment-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { "type": "string", @@ -277312,7 +276891,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" } } @@ -278168,8 +277747,41 @@ "Operations": { "type": "array", "description": "Array of [SCIM operations](https://tools.ietf.org/html/rfc7644#section-3.5.2).", + "minItems": 1, "items": { - "type": "object" + "type": "object", + "properties": { + "op": { + "type": "string", + "enum": [ + "add", + "Add", + "remove", + "Remove", + "replace", + "Replace" + ] + }, + "path": { + "type": "string" + }, + "value": { + "oneOf": [ + { + "type": "string" + }, + { + "type": "object" + }, + { + "type": "array" + } + ] + } + }, + "required": [ + "op" + ] } } }, @@ -325930,7 +325542,7 @@ "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -325955,7 +325567,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -327263,7 +326875,7 @@ }, "post": { "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -327294,7 +326906,7 @@ "type": "string" }, "private": { - "description": "Whether the repository is private or public.", + "description": "Whether the repository is private.", "default": false, "type": "boolean" }, @@ -355468,7 +355080,7 @@ "/users/{username}/repos": { "get": { "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], diff --git a/lib/rest/static/dereferenced/ghes-2.18.deref.json b/lib/rest/static/dereferenced/ghes-2.18.deref.json index 98d31cf02680..11b1bbf94672 100644 --- a/lib/rest/static/dereferenced/ghes-2.18.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.18.deref.json @@ -49563,7 +49563,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -51251,7 +51251,7 @@ }, "post": { "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -51290,12 +51290,12 @@ }, "private": { "type": "boolean", - "description": "Either `true` to create a private repository or `false` to create a public one.", + "description": "Whether the repository is private.", "default": false }, "visibility": { "type": "string", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "enum": [ "public", "private", @@ -79203,7 +79203,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -79213,6 +79213,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -201459,7 +201460,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.18/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -202630,7 +202631,7 @@ "/repositories": { "get": { "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.18/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -202651,7 +202652,7 @@ }, { "name": "visibility", - "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.", + "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.", "in": "query", "required": false, "schema": { @@ -239677,7 +239678,7 @@ "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -239702,7 +239703,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -240980,7 +240981,7 @@ }, "post": { "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.18/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -241011,7 +241012,7 @@ "type": "string" }, "private": { - "description": "Whether the repository is private or public.", + "description": "Whether the repository is private.", "default": false, "type": "boolean" }, @@ -266446,7 +266447,7 @@ "/users/{username}/repos": { "get": { "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], diff --git a/lib/rest/static/dereferenced/ghes-2.19.deref.json b/lib/rest/static/dereferenced/ghes-2.19.deref.json index c52215602e03..5206af05c249 100644 --- a/lib/rest/static/dereferenced/ghes-2.19.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.19.deref.json @@ -50206,7 +50206,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -51894,7 +51894,7 @@ }, "post": { "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -51933,12 +51933,12 @@ }, "private": { "type": "boolean", - "description": "Either `true` to create a private repository or `false` to create a public one.", + "description": "Whether the repository is private.", "default": false }, "visibility": { "type": "string", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "enum": [ "public", "private", @@ -82135,7 +82135,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -82145,6 +82145,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -204883,7 +204884,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.19/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -206054,7 +206055,7 @@ "/repositories": { "get": { "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.19/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -206075,7 +206076,7 @@ }, { "name": "visibility", - "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.", + "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.", "in": "query", "required": false, "schema": { @@ -242931,7 +242932,7 @@ "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -242956,7 +242957,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -244234,7 +244235,7 @@ }, "post": { "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.19/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -244265,7 +244266,7 @@ "type": "string" }, "private": { - "description": "Whether the repository is private or public.", + "description": "Whether the repository is private.", "default": false, "type": "boolean" }, @@ -269750,7 +269751,7 @@ "/users/{username}/repos": { "get": { "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], diff --git a/lib/rest/static/dereferenced/ghes-2.20.deref.json b/lib/rest/static/dereferenced/ghes-2.20.deref.json index 9f3bd5a35596..9c8e31506973 100644 --- a/lib/rest/static/dereferenced/ghes-2.20.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.20.deref.json @@ -11412,7 +11412,10 @@ "type": "string", "description": "The OAuth access token used to authenticate to the GitHub API." } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -53240,7 +53243,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -54940,7 +54943,7 @@ }, "post": { "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -54979,12 +54982,12 @@ }, "private": { "type": "boolean", - "description": "Either `true` to create a private repository or `false` to create a public one.", + "description": "Whether the repository is private.", "default": false }, "visibility": { "type": "string", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "enum": [ "public", "private", @@ -84241,7 +84244,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -84251,6 +84254,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -207878,7 +207882,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.20/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -209058,7 +209062,7 @@ "/repositories": { "get": { "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.20/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -209079,7 +209083,7 @@ }, { "name": "visibility", - "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.", + "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.", "in": "query", "required": false, "schema": { @@ -246006,7 +246010,7 @@ "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -246031,7 +246035,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -247318,7 +247322,7 @@ }, "post": { "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.20/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -247349,7 +247353,7 @@ "type": "string" }, "private": { - "description": "Whether the repository is private or public.", + "description": "Whether the repository is private.", "default": false, "type": "boolean" }, @@ -272936,7 +272940,7 @@ "/users/{username}/repos": { "get": { "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], diff --git a/lib/rest/static/dereferenced/ghes-2.21.deref.json b/lib/rest/static/dereferenced/ghes-2.21.deref.json index 023000e1a414..8aaab6d84bcb 100644 --- a/lib/rest/static/dereferenced/ghes-2.21.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.21.deref.json @@ -11417,7 +11417,10 @@ "type": "string", "description": "The OAuth access token used to authenticate to the GitHub API." } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -53326,7 +53329,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -55039,7 +55042,7 @@ }, "post": { "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -55078,12 +55081,12 @@ }, "private": { "type": "boolean", - "description": "Either `true` to create a private repository or `false` to create a public one.", + "description": "Whether the repository is private.", "default": false }, "visibility": { "type": "string", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "enum": [ "public", "private", @@ -95074,7 +95077,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -95084,6 +95087,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -219497,7 +219501,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.21/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -220686,7 +220690,7 @@ "/repositories": { "get": { "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.21/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -220707,7 +220711,7 @@ }, { "name": "visibility", - "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.", + "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.", "in": "query", "required": false, "schema": { @@ -255005,7 +255009,7 @@ "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -255030,7 +255034,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -256327,7 +256331,7 @@ }, "post": { "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.21/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -256358,7 +256362,7 @@ "type": "string" }, "private": { - "description": "Whether the repository is private or public.", + "description": "Whether the repository is private.", "default": false, "type": "boolean" }, @@ -282045,7 +282049,7 @@ "/users/{username}/repos": { "get": { "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], diff --git a/lib/rest/static/dereferenced/ghes-2.22.deref.json b/lib/rest/static/dereferenced/ghes-2.22.deref.json index b6920c803529..a5ca44119ea2 100644 --- a/lib/rest/static/dereferenced/ghes-2.22.deref.json +++ b/lib/rest/static/dereferenced/ghes-2.22.deref.json @@ -11510,7 +11510,10 @@ "type": "string", "description": "The OAuth access token used to authenticate to the GitHub API." } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -51279,7 +51282,8 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-an-organization-public-key) endpoint." + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { "type": "string", @@ -51304,7 +51308,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "visibility": "selected", "selected_repository_ids": [ @@ -64168,7 +64172,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -65990,7 +65994,7 @@ }, "post": { "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -66029,12 +66033,12 @@ }, "private": { "type": "boolean", - "description": "Either `true` to create a private repository or `false` to create a public one.", + "description": "Whether the repository is private.", "default": false }, "visibility": { "type": "string", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "enum": [ "public", "private", @@ -105823,7 +105827,8 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-a-repository-public-key) endpoint." + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@2.22/rest/reference/actions#get-a-repository-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { "type": "string", @@ -105832,7 +105837,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" } } @@ -121964,7 +121969,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -121974,6 +121979,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -248636,7 +248642,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@2.22/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -249822,7 +249828,7 @@ "/repositories": { "get": { "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@2.22/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -249843,7 +249849,7 @@ }, { "name": "visibility", - "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.", + "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.", "in": "query", "required": false, "schema": { @@ -284259,7 +284265,7 @@ "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -284284,7 +284290,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -285592,7 +285598,7 @@ }, "post": { "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@2.22/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -285623,7 +285629,7 @@ "type": "string" }, "private": { - "description": "Whether the repository is private or public.", + "description": "Whether the repository is private.", "default": false, "type": "boolean" }, @@ -311439,7 +311445,7 @@ "/users/{username}/repos": { "get": { "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], diff --git a/lib/rest/static/dereferenced/ghes-3.0.deref.json b/lib/rest/static/dereferenced/ghes-3.0.deref.json index 5eb7269244f7..663a6c26ed22 100644 --- a/lib/rest/static/dereferenced/ghes-3.0.deref.json +++ b/lib/rest/static/dereferenced/ghes-3.0.deref.json @@ -11724,7 +11724,10 @@ "type": "string", "description": "The OAuth access token used to authenticate to the GitHub API." } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -11862,7 +11865,7 @@ "type": "integer" }, "repositories": { - "description": "The list of repository IDs to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", + "description": "The list of repository names to scope the user-to-server access token to. `repositories` may not be specified if `repository_ids` is specified.", "type": "array", "items": { "type": "string", @@ -11870,7 +11873,7 @@ } }, "repository_ids": { - "description": "The list of repository names to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", + "description": "The list of repository IDs to scope the user-to-server access token to. `repository_ids` may not be specified if `repositories` is specified.", "example": [ 1 ], @@ -12131,7 +12134,10 @@ "single_file": "read" } } - } + }, + "required": [ + "access_token" + ] } } } @@ -55559,7 +55565,8 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-an-organization-public-key) endpoint." + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { "type": "string", @@ -55584,7 +55591,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678", "visibility": "selected", "selected_repository_ids": [ @@ -68698,7 +68705,7 @@ }, { "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", "in": "query", "required": false, "schema": { @@ -70520,7 +70527,7 @@ }, "post": { "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -70559,12 +70566,12 @@ }, "private": { "type": "boolean", - "description": "Either `true` to create a private repository or `false` to create a public one.", + "description": "Whether the repository is private.", "default": false }, "visibility": { "type": "string", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", "enum": [ "public", "private", @@ -110822,7 +110829,8 @@ "properties": { "encrypted_value": { "type": "string", - "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-a-repository-public-key) endpoint." + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/enterprise-server@3.0/rest/reference/actions#get-a-repository-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, "key_id": { "type": "string", @@ -110831,7 +110839,7 @@ } }, "example": { - "encrypted_value": "****************************************************************************************", + "encrypted_value": "c2VjcmV0", "key_id": "012345678912345678" } } @@ -127087,7 +127095,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -127097,6 +127105,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -253962,7 +253971,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/enterprise-server@3.0/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -255148,7 +255157,7 @@ "/repositories": { "get": { "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/enterprise-server@3.0/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -255169,7 +255178,7 @@ }, { "name": "visibility", - "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`.", + "description": "Specifies the types of repositories to return. Can be one of `all` or `public`. Default: `public`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.", "in": "query", "required": false, "schema": { @@ -289609,7 +289618,7 @@ "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -289634,7 +289643,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -290942,7 +290951,7 @@ }, "post": { "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/enterprise-server@3.0/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -290973,7 +290982,7 @@ "type": "string" }, "private": { - "description": "Whether the repository is private or public.", + "description": "Whether the repository is private.", "default": false, "type": "boolean" }, @@ -316808,7 +316817,7 @@ "/users/{username}/repos": { "get": { "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], diff --git a/lib/rest/static/dereferenced/github.ae.deref.json b/lib/rest/static/dereferenced/github.ae.deref.json index 51aea78fb5c1..4fb966764aa1 100644 --- a/lib/rest/static/dereferenced/github.ae.deref.json +++ b/lib/rest/static/dereferenced/github.ae.deref.json @@ -9559,7 +9559,10 @@ "type": "string", "description": "The OAuth access token used to authenticate to the GitHub API." } - } + }, + "required": [ + "access_token" + ] }, "example": { "access_token": "e72e16c7e42f292c6912e7710c838347ae178b4a" @@ -12890,19 +12893,188 @@ } } }, - "/events": { + "/enterprises/{enterprise}/actions/permissions": { "get": { - "summary": "List public events", - "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "summary": "Get GitHub Actions permissions for an enterprise", + "description": "Gets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-github-actions-permissions-enterprise", "tags": [ - "activity" + "enterprise-admin" ], - "operationId": "activity/list-public-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#list-public-events" + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-github-actions-permissions-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_organizations": { + "type": "string", + "description": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "enum": [ + "all", + "none", + "selected" + ] + }, + "selected_organizations_url": { + "type": "string", + "description": "The API URL to use to get or set the selected organizations that are allowed to run GitHub Actions, when `enabled_organizations` is set to `selected`." + }, + "allowed_actions": { + "type": "string", + "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "enum": [ + "all", + "local_only", + "selected" + ] + }, + "selected_actions_url": { + "type": "string", + "description": "The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`." + } + }, + "required": [ + "enabled_organizations", + "allowed_actions" + ] + }, + "examples": { + "default": { + "value": { + "enabled_organizations": "all", + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/enterprises/2/actions/permissions/selected-actions" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "put": { + "summary": "Set GitHub Actions permissions for an enterprise", + "description": "Sets the GitHub Actions permissions policy for organizations and allowed actions in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-github-actions-permissions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-github-actions-permissions-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_organizations": { + "type": "string", + "description": "The policy that controls the organizations in the enterprise that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "enum": [ + "all", + "none", + "selected" + ] + }, + "allowed_actions": { + "type": "string", + "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "enum": [ + "all", + "local_only", + "selected" + ] + } + }, + "required": [ + "enabled_organizations" + ] + }, + "example": { + "enabled_organizations": "all", + "allowed_actions": "selected" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/permissions/organizations": { + "get": { + "summary": "List selected organizations enabled for GitHub Actions in an enterprise", + "description": "Lists the organizations that are selected to have GitHub Actions enabled in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-selected-organizations-enabled-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-selected-organizations-enabled-for-github-actions-in-an-enterprise" }, "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, { "name": "per_page", "description": "Results per page (max 100).", @@ -12928,110 +13100,1948 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Event", - "description": "Event", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": "string", - "nullable": true - }, - "actor": { - "title": "Actor", - "description": "Actor", + "type": "object", + "properties": { + "total_count": { + "type": "number" + }, + "organizations": { + "type": "array", + "items": { + "title": "Organization Simple", + "description": "Organization Simple", "type": "object", "properties": { - "id": { - "type": "integer" - }, "login": { - "type": "string" + "type": "string", + "example": "github" }, - "display_login": { - "type": "string" + "id": { + "type": "integer", + "example": 1 }, - "gravatar_id": { + "node_id": { "type": "string", - "nullable": true + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" }, "avatar_url": { "type": "string", - "format": "uri" + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true } }, "required": [ - "id", "login", - "gravatar_id", "url", - "avatar_url" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" ] - }, - "repo": { + } + } + }, + "required": [ + "total_count", + "organizations" + ] + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "organizations": [ + { + "login": "octocat", + "id": 161335, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "url": "https://api.github.com/orgs/octo-org", + "repos_url": "https://api.github.com/orgs/octo-org/repos", + "events_url": "https://api.github.com/orgs/octo-org/events", + "hooks_url": "https://api.github.com/orgs/octo-org/hooks", + "issues_url": "https://api.github.com/orgs/octo-org/issues", + "members_url": "https://api.github.com/orgs/octo-org/members{/member}", + "public_members_url": "https://api.github.com/orgs/octo-org/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "put": { + "summary": "Set selected organizations enabled for GitHub Actions in an enterprise", + "description": "Replaces the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-selected-organizations-enabled-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-selected-organizations-enabled-for-github-actions-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_organization_ids": { + "description": "List of organization IDs to enable for GitHub Actions.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the organization." + } + } + }, + "required": [ + "selected_organization_ids" + ] + }, + "example": { + "selected_organization_ids": [ + 32, + 91 + ] + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/permissions/organizations/{org_id}": { + "put": { + "summary": "Enable a selected organization for GitHub Actions in an enterprise", + "description": "Adds an organization to the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/enable-selected-organization-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#enable-a-selected-organization-for-github-actions-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org_id", + "description": "Unique identifier of an organization.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "delete": { + "summary": "Disable a selected organization for GitHub Actions in an enterprise", + "description": "Removes an organization from the list of selected organizations that are enabled for GitHub Actions in an enterprise. To use this endpoint, the enterprise permission policy for `enabled_organizations` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/disable-selected-organization-github-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#disable-a-selected-organization-for-github-actions-in-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "org_id", + "description": "Unique identifier of an organization.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/permissions/selected-actions": { + "get": { + "summary": "Get allowed actions for an enterprise", + "description": "Gets the selected actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-allowed-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-allowed-actions-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." + }, + "verified_allowed": { + "type": "boolean", + "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators." + }, + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "items": { + "type": "string" + } + } + }, + "required": [ + "github_owned_allowed", + "patterns_allowed", + "verified_allowed" + ] + }, + "examples": { + "default": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "put": { + "summary": "Set allowed actions for an enterprise", + "description": "Sets the actions that are allowed in an enterprise. To use this endpoint, the enterprise permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an enterprise](#set-github-actions-permissions-for-an-enterprise).\"\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-allowed-actions-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-allowed-actions-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." + }, + "verified_allowed": { + "type": "boolean", + "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators." + }, + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "items": { + "type": "string" + } + } + }, + "required": [ + "github_owned_allowed", + "patterns_allowed", + "verified_allowed" + ] + }, + "examples": { + "selected_actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runner-groups": { + "get": { + "summary": "List self-hosted runner groups for an enterprise", + "description": "Lists all self-hosted runner groups for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-self-hosted-runner-groups-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-self-hosted-runner-groups-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "number" + }, + "runner_groups": { + "type": "array", + "items": { "type": "object", "properties": { "id": { - "type": "integer" + "type": "number" }, "name": { "type": "string" }, - "url": { - "type": "string", - "format": "uri" + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_organizations_url": { + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "allows_public_repositories": { + "type": "boolean" } }, "required": [ "id", "name", - "url" + "visibility", + "allows_public_repositories", + "default", + "runners_url" ] - }, - "org": { - "title": "Actor", - "description": "Actor", + } + } + }, + "required": [ + "total_count", + "runner_groups" + ] + }, + "examples": { + "default": { + "value": { + "total_count": 3, + "runner_groups": [ + { + "id": 1, + "name": "Default", + "visibility": "all", + "default": true, + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/1/runners", + "allows_public_repositories": false + }, + { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/organizations", + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/2/runners", + "allows_public_repositories": true + }, + { + "id": 3, + "name": "expensive-hardware", + "visibility": "private", + "default": false, + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner_groups/3/runners", + "allows_public_repositories": true + } + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "post": { + "summary": "Create a self-hosted runner group for an enterprise", + "description": "Creates a new self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/create-self-hosted-runner-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#create-self-hosted-runner-group-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all organizations or select individual organization. Can be one of: `all` or `selected`", + "type": "string", + "enum": [ + "selected", + "all" + ] + }, + "selected_organization_ids": { + "description": "List of organization IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the organization." + } + }, + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + } + }, + "required": [ + "name" + ] + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected", + "selected_organization_ids": [ + 32, + 91 + ], + "runners": [ + 9, + 2 + ] + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_organizations_url": { + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "allows_public_repositories": { + "type": "boolean" + } + }, + "required": [ + "id", + "name", + "visibility", + "allows_public_repositories", + "default", + "runners_url" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", + "allows_public_repositories": false + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}": { + "get": { + "summary": "Get a self-hosted runner group for an enterprise", + "description": "Gets a specific self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-self-hosted-runner-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-a-self-hosted-runner-group-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_organizations_url": { + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "allows_public_repositories": { + "type": "boolean" + } + }, + "required": [ + "id", + "name", + "visibility", + "allows_public_repositories", + "default", + "runners_url" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", + "allows_public_repositories": false + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "patch": { + "summary": "Update a self-hosted runner group for an enterprise", + "description": "Updates the `name` and `visibility` of a self-hosted runner group in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/update-self-hosted-runner-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#update-a-self-hosted-runner-group-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all organizations or select individual organizations. Can be one of: `all` or `selected`", + "type": "string", + "enum": [ + "selected", + "all" + ], + "default": "all" + } + } + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "number" + }, + "name": { + "type": "string" + }, + "visibility": { + "type": "string" + }, + "default": { + "type": "boolean" + }, + "selected_organizations_url": { + "type": "string" + }, + "runners_url": { + "type": "string" + }, + "allows_public_repositories": { + "type": "boolean" + } + }, + "required": [ + "id", + "name", + "visibility", + "allows_public_repositories", + "default", + "runners_url" + ] + }, + "examples": { + "default": { + "value": { + "id": 2, + "name": "Expensive hardware runners", + "visibility": "selected", + "default": false, + "selected_organizations_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/organizations", + "runners_url": "https://api.github.com/enterprises/octo-corp/actions/runner-groups/2/runners", + "allows_public_repositories": true + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "delete": { + "summary": "Delete a self-hosted runner group from an enterprise", + "description": "Deletes a self-hosted runner group for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/delete-self-hosted-runner-group-from-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#delete-a-self-hosted-runner-group-from-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners": { + "get": { + "summary": "List self-hosted runners in a group for an enterprise", + "description": "Lists the self-hosted runners that are in a specific enterprise group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-self-hosted-runners-in-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-self-hosted-runners-in-a-group-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "number" + }, + "runners": { + "type": "array", + "items": { + "title": "Self hosted runners", + "description": "A self hosted runner", "type": "object", "properties": { "id": { - "type": "integer" - }, - "login": { - "type": "string" - }, - "display_login": { - "type": "string" + "description": "The id of the runner.", + "type": "integer", + "example": 5 }, - "gravatar_id": { + "name": { + "description": "The name of the runner.", "type": "string", - "nullable": true + "example": "iMac" }, - "url": { + "os": { + "description": "The Operating System of the runner.", "type": "string", - "format": "uri" + "example": "macos" }, - "avatar_url": { + "status": { + "description": "The status of the runner.", "type": "string", - "format": "uri" + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + } + } } }, "required": [ "id", - "login", - "gravatar_id", - "url", - "avatar_url" + "name", + "os", + "status", + "busy", + "labels" ] - }, - "payload": { + } + } + }, + "required": [ + "total_count", + "runners" + ] + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "runners": [ + { + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 11, + "name": "Linux", + "type": "read-only" + } + ] + }, + { + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "put": { + "summary": "Set self-hosted runners in a group for an enterprise", + "description": "Replaces the list of self-hosted runners that are part of an enterprise runner group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/set-self-hosted-runners-in-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#set-self-hosted-runners-in-a-group-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + } + }, + "required": [ + "runners" + ] + }, + "example": { + "runners": [ + 9, + 2 + ] + } + } + } + }, + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runner-groups/{runner_group_id}/runners/{runner_id}": { + "put": { + "summary": "Add a self-hosted runner to a group for an enterprise", + "description": "Adds a self-hosted runner to a runner group configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise`\nscope to use this endpoint.", + "operationId": "enterprise-admin/add-self-hosted-runner-to-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#add-a-self-hosted-runner-to-a-group-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "delete": { + "summary": "Remove a self-hosted runner from a group for an enterprise", + "description": "Removes a self-hosted runner from a group configured in an enterprise. The runner is then returned to the default group.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/remove-self-hosted-runner-from-group-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#remove-a-self-hosted-runner-from-a-group-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runners": { + "get": { + "summary": "List self-hosted runners for an enterprise", + "description": "Lists all self-hosted runners configured for an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/list-self-hosted-runners-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#list-self-hosted-runners-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "type": "number" + }, + "runners": { + "type": "array", + "items": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The id of the runner.", + "type": "integer", + "example": 5 + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "example": "iMac" + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + } + } + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "runners": [ + { + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 11, + "name": "Linux", + "type": "read-only" + } + ] + }, + { + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/enterprises/{enterprise}/actions/runners/{runner_id}": { + "get": { + "summary": "Get a self-hosted runner for an enterprise", + "description": "Gets a specific self-hosted runner configured in an enterprise.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/get-self-hosted-runner-for-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#get-a-self-hosted-runner-for-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The id of the runner.", + "type": "integer", + "example": 5 + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "example": "iMac" + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + } + } + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + }, + "examples": { + "default": { + "value": { + "id": 23, + "name": "MBP", + "os": "macos", + "status": "online", + "busy": true, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + }, + "delete": { + "summary": "Delete a self-hosted runner from an enterprise", + "description": "Forces the removal of a self-hosted runner from an enterprise. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:enterprise` scope to use this endpoint.", + "operationId": "enterprise-admin/delete-self-hosted-runner-from-enterprise", + "tags": [ + "enterprise-admin" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/enterprise-admin#delete-self-hosted-runner-from-an-enterprise" + }, + "parameters": [ + { + "name": "enterprise", + "description": "The slug version of the enterprise name. You can also substitute this value with the enterprise id.", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": false, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "enterprise-admin", + "subcategory": "actions" + } + } + }, + "/events": { + "get": { + "summary": "List public events", + "description": "We delay the public events feed by five minutes, which means the most recent event returned by the public events API actually occurred at least five minutes ago.", + "tags": [ + "activity" + ], + "operationId": "activity/list-public-events", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#list-public-events" + }, + "parameters": [ + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Event", + "description": "Event", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string", + "nullable": true + }, + "actor": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "name", + "url" + ] + }, + "org": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] + }, + "payload": { "type": "object", "properties": { "action": { @@ -34819,17 +36829,175 @@ } } }, - "/orgs/{org}/events": { + "/orgs/{org}/actions/permissions": { "get": { - "summary": "List public organization events", - "description": "", + "summary": "Get GitHub Actions permissions for an organization", + "description": "Gets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/get-github-actions-permissions-organization", "tags": [ - "activity" + "actions" ], - "operationId": "activity/list-public-org-events", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#list-public-organization-events" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-github-actions-permissions-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_repositories": { + "type": "string", + "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "enum": [ + "all", + "none", + "selected" + ] + }, + "selected_repositories_url": { + "type": "string", + "description": "The API URL to use to get or set the selected repositories that are allowed to run GitHub Actions, when `enabled_repositories` is set to `selected`." + }, + "allowed_actions": { + "type": "string", + "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "enum": [ + "all", + "local_only", + "selected" + ] + }, + "selected_actions_url": { + "type": "string", + "description": "The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`." + } + }, + "required": [ + "enabled_repositories", + "allowed_actions" + ] + }, + "examples": { + "default": { + "value": { + "enabled_repositories": "all", + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/organizations/42/actions/permissions/selected-actions" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set GitHub Actions permissions for an organization", + "description": "Sets the GitHub Actions permissions policy for repositories and allowed actions in an organization.\n\nIf the organization belongs to an enterprise that has set restrictive permissions at the enterprise level, such as `allowed_actions` to `selected` actions, then you cannot override them for the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/set-github-actions-permissions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-github-actions-permissions-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled_repositories": { + "type": "string", + "description": "The policy that controls the repositories in the organization that are allowed to run GitHub Actions. Can be one of: `all`, `none`, or `selected`.", + "enum": [ + "all", + "none", + "selected" + ] + }, + "allowed_actions": { + "type": "string", + "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "enum": [ + "all", + "local_only", + "selected" + ] + } + }, + "required": [ + "enabled_repositories" + ] + }, + "example": { + "enabled_repositories": "all", + "allowed_actions": "selected" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/repositories": { + "get": { + "summary": "List selected repositories enabled for GitHub Actions in an organization", + "description": "Lists the selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/list-selected-repositories-enabled-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-selected-repositories-enabled-for-github-actions-in-an-organization" }, "parameters": [ { @@ -34865,2664 +37033,1111 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Event", - "description": "Event", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "type": { - "type": "string", - "nullable": true - }, - "actor": { - "title": "Actor", - "description": "Actor", + "type": "object", + "required": [ + "total_count", + "repositories" + ], + "properties": { + "total_count": { + "type": "number" + }, + "repositories": { + "type": "array", + "items": { + "title": "Repository", + "description": "A git repository", "type": "object", "properties": { "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer" }, - "login": { - "type": "string" + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "display_login": { - "type": "string" + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" }, - "gravatar_id": { + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { "type": "string", + "example": "This your first repo!", "nullable": true }, + "fork": { + "type": "boolean" + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "avatar_url": { + "archive_url": { "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer" + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "name": { - "type": "string" + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, - "url": { + "blobs_url": { "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "name", - "url" - ] - }, - "org": { - "title": "Actor", - "description": "Actor", - "type": "object", - "properties": { - "id": { - "type": "integer" + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - "login": { - "type": "string" + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - "display_login": { - "type": "string" + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - "gravatar_id": { + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, - "url": { + "hooks_url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, - "avatar_url": { + "svn_url": { "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "login", - "gravatar_id", - "url", - "avatar_url" - ] - }, - "payload": { - "type": "object", - "properties": { - "action": { + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", "type": "string" }, - "issue": { - "title": "Issue Simple", - "description": "Issue Simple", + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, "type": "object", "properties": { "id": { - "type": "integer", - "example": 1 + "type": "integer" }, "node_id": { - "type": "string", - "example": "MDU6SXNzdWUx" + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" }, "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" + "type": "string" }, - "repository_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" + "archive_url": { + "type": "string" }, - "labels_url": { - "type": "string", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}" + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" }, "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" }, "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events" + "type": "string" }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World/issues/1347" + "forks_url": { + "type": "string" }, - "number": { - "type": "integer", - "example": 1347 + "git_commits_url": { + "type": "string" }, - "state": { - "type": "string", - "example": "open" + "git_refs_url": { + "type": "string" }, - "title": { - "type": "string", - "example": "Found a bug" + "git_tags_url": { + "type": "string" }, - "body": { - "type": "string", - "example": "I'm having a problem with this." + "git_url": { + "type": "string" }, - "user": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] + "issue_comment_url": { + "type": "string" }, - "labels": { - "type": "array", - "items": { - "title": "Label", - "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 208045946 - }, - "node_id": { - "type": "string", - "example": "MDU6TGFiZWwyMDgwNDU5NDY=" - }, - "url": { - "description": "URL for the label", - "example": "https://api.github.com/repositories/42/labels/bug", - "type": "string", - "format": "uri" - }, - "name": { - "description": "The name of the label.", - "example": "bug", - "type": "string" - }, - "description": { - "type": "string", - "example": "Something isn't working", - "nullable": true - }, - "color": { - "description": "6-character hex code, without the leading #, identifying the color", - "example": "FFFFFF", - "type": "string" - }, - "default": { - "type": "boolean", - "example": true - } - }, - "required": [ - "id", - "node_id", - "url", - "name", - "description", - "color", - "default" - ] - } + "issue_events_url": { + "type": "string" }, - "assignee": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] + "issues_url": { + "type": "string" }, - "assignees": { + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { "type": "array", "items": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "nullable": true - }, - "milestone": { - "nullable": true, - "allOf": [ - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" - }, - "number": { - "description": "The number of the milestone.", - "type": "integer", - "example": 42 - }, - "state": { - "description": "The state of the milestone.", - "example": "open", - "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" - }, - "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" - }, - "description": { - "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true - }, - "creator": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true - }, - "due_on": { - "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ] - } - ] + "type": "string" + } }, - "locked": { - "type": "boolean", - "example": true + "has_issues": { + "type": "boolean" }, - "active_lock_reason": { - "type": "string", - "example": "too heated", - "nullable": true + "has_projects": { + "type": "boolean" }, - "comments": { - "type": "integer", - "example": 0 + "has_wiki": { + "type": "boolean" }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] + "has_pages": { + "type": "boolean" }, - "closed_at": { - "type": "string", - "format": "date-time", - "nullable": true + "has_downloads": { + "type": "boolean" }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-22T13:33:48Z" + "archived": { + "type": "boolean" }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-22T13:33:48Z" + "disabled": { + "type": "boolean" }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] + "visibility": { + "type": "string" }, - "body_html": { + "pushed_at": { "type": "string" }, - "body_text": { + "created_at": { "type": "string" }, - "timeline_url": { - "type": "string", - "format": "uri" + "updated_at": { + "type": "string" }, - "repository": { - "title": "Repository", - "description": "A git repository", + "permissions": { "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "nullable": true, - "allOf": [ - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, + "admin": { "type": "boolean" }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { + "push": { "type": "boolean" }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, + "pull": { "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "template_repository": { - "nullable": true, - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "language": { - "type": "string" - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] + } }, - "performed_via_github_app": { - "nullable": true, - "allOf": [ - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "owner": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "example": 5, - "type": "integer" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "client_secret": { - "type": "string", - "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - }, - "webhook_secret": { - "type": "string", - "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - }, - "pem": { - "type": "string", - "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ], - "additionalProperties": true - } - ] - } - }, - "required": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "author_association", - "created_at", - "updated_at" - ] - }, - "comment": { - "title": "Issue Comment", - "description": "Comments provide a way for people to collaborate on an issue.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the issue comment", - "example": 42, - "type": "integer" + "allow_rebase_merge": { + "type": "boolean" }, - "node_id": { + "temp_clone_token": { "type": "string" }, - "url": { - "description": "URL for the issue comment", - "example": "https://api.github.com/repositories/42/issues/comments/1", - "type": "string", - "format": "uri" - }, - "body": { - "description": "Contents of the issue comment", - "example": "What version of Safari were you using when you observed this bug?", - "type": "string" + "allow_squash_merge": { + "type": "boolean" }, - "body_text": { - "type": "string" + "delete_branch_on_merge": { + "type": "boolean" }, - "body_html": { - "type": "string" + "allow_merge_commit": { + "type": "boolean" }, - "html_url": { - "type": "string", - "format": "uri" + "subscribers_count": { + "type": "integer" }, - "user": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-14T16:00:49Z" - }, - "issue_url": { - "type": "string", - "format": "uri" - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "performed_via_github_app": { - "nullable": true, - "allOf": [ - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "owner": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "example": 5, - "type": "integer" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "client_secret": { - "type": "string", - "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - }, - "webhook_secret": { - "type": "string", - "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - }, - "pem": { - "type": "string", - "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ], - "additionalProperties": true - } - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "id", - "node_id", - "html_url", - "issue_url", - "author_association", - "user", - "url", - "created_at", - "updated_at" - ] - }, - "pages": { - "type": "array", - "items": { - "type": "object", - "properties": { - "page_name": { - "type": "string" - }, - "title": { - "type": "string" - }, - "summary": { - "type": "string", - "nullable": true - }, - "action": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "html_url": { - "type": "string" - } + "network_count": { + "type": "integer" } } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" } }, "required": [ - "action" + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" ] - }, - "public": { - "type": "boolean" - }, - "created_at": { - "type": "string", - "format": "date-time", - "nullable": true } - }, - "required": [ - "id", - "type", - "actor", - "repo", - "payload", - "public", - "created_at" - ] + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "repositories": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + ] + } } } } @@ -37530,27 +38145,91 @@ } }, "x-github": { + "enabledForGitHubApps": true, "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set selected repositories enabled for GitHub Actions in an organization", + "description": "Replaces the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/set-selected-repositories-enabled-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-enabled-for-github-actions-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "description": "List of repository IDs to enable for GitHub Actions.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + } + }, + "required": [ + "selected_repository_ids" + ] + }, + "example": { + "selected_repository_ids": [ + 32, + 42 + ] + } + } + } + }, + "x-github": { "enabledForGitHubApps": true, + "githubCloudOnly": false, "previews": [ ], - "category": "activity", - "subcategory": "events" + "category": "actions", + "subcategory": "permissions" } } }, - "/orgs/{org}/hooks": { - "get": { - "summary": "List organization webhooks", - "description": "", + "/orgs/{org}/actions/permissions/repositories/{repository_id}": { + "put": { + "summary": "Enable a selected repository for GitHub Actions in an organization", + "description": "Adds a repository to the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/enable-selected-repository-github-actions-organization", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/list-webhooks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#list-organization-webhooks" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#enable-a-selected-repository-for-github-actions-in-an-organization" }, "parameters": [ { @@ -37562,21 +38241,93 @@ } }, { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", + "name": "repository_id", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "delete": { + "summary": "Disable a selected repository for GitHub Actions in an organization", + "description": "Removes a repository from the list of selected repositories that are enabled for GitHub Actions in an organization. To use this endpoint, the organization permission policy for `enabled_repositories` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/disable-selected-repository-github-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#disable-a-selected-repository-for-github-actions-in-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" } }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", + "name": "repository_id", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/orgs/{org}/actions/permissions/selected-actions": { + "get": { + "summary": "Get allowed actions for an organization", + "description": "Gets the selected actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\"\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/get-allowed-actions-organization", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-allowed-actions-for-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" } } ], @@ -37586,142 +38337,39 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Org Hook", - "description": "Org Hook", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1" - }, - "ping_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1/pings" - }, - "name": { - "type": "string", - "example": "web" - }, - "events": { - "type": "array", - "example": [ - "push", - "pull_request" - ], - "items": { - "type": "string" - } - }, - "active": { - "type": "boolean", - "example": true - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "example": "\"http://example.com/2\"" - }, - "insecure_ssl": { - "type": "string", - "example": "\"0\"" - }, - "content_type": { - "type": "string", - "example": "\"form\"" - }, - "secret": { - "type": "string", - "example": "\"********\"" - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-09-06T20:39:23Z" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-09-06T17:26:27Z" - }, - "type": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." + }, + "verified_allowed": { + "type": "boolean", + "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators." + }, + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "items": { "type": "string" } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at" - ] - } + } + }, + "required": [ + "github_owned_allowed", + "patterns_allowed", + "verified_allowed" + ] }, "examples": { "default": { - "value": [ - { - "id": 1, - "url": "https://api.github.com/orgs/octocat/hooks/1", - "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", - "name": "web", - "events": [ - "push", - "pull_request" - ], - "active": true, - "config": { - "url": "http://example.com", - "content_type": "json" - }, - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "type": "Organization" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Resource Not Found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] } } } @@ -37730,25 +38378,25 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "previews": [ ], - "category": "orgs", - "subcategory": "webhooks" + "category": "actions", + "subcategory": "permissions" } }, - "post": { - "summary": "Create an organization webhook", - "description": "Here's how you can create a hook that posts payloads in JSON format:", + "put": { + "summary": "Set allowed actions for an organization", + "description": "Sets the actions that are allowed in an organization. To use this endpoint, the organization permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for an organization](#set-github-actions-permissions-for-an-organization).\"\n\nIf the organization belongs to an enterprise that has `selected` actions set at the enterprise level, then you cannot override any of the enterprise's allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the organization must belong to an enterprise. If the organization does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories in the organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `administration` organization permission to use this API.", + "operationId": "actions/set-allowed-actions-organization", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/create-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#create-an-organization-webhook" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-allowed-actions-for-an-organization" }, "parameters": [ { @@ -37760,325 +38408,76 @@ } } ], + "responses": { + "204": { + "description": "Empty response" + } + }, "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Must be passed as \"web\"." + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." }, - "config": { - "type": "object", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/github-ae@latest/rest/reference/orgs#create-hook-config-params).", - "properties": { - "url": { - "type": "string", - "description": "The URL to which the payloads will be delivered.", - "example": "https://example.com/webhook", - "format": "uri" - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "example": "\"json\"" - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "example": "\"********\"" - }, - "insecure_ssl": { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "example": "\"0\"" - }, - "username": { - "type": "string", - "example": "\"kdaigle\"" - }, - "password": { - "type": "string", - "example": "\"password\"" - } - }, - "required": [ - "url" - ] + "verified_allowed": { + "type": "boolean", + "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators." }, - "events": { + "patterns_allowed": { "type": "array", - "description": "Determines what [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) the hook is triggered for.", - "default": [ - "push" - ], + "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", "items": { "type": "string" } - }, - "active": { - "type": "boolean", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "default": true } }, "required": [ - "name", - "config" + "github_owned_allowed", + "patterns_allowed", + "verified_allowed" ] }, - "example": { - "name": "web", - "active": true, - "events": [ - "push", - "pull_request" - ], - "config": { - "url": "http://example.com/webhook", - "content_type": "json" - } - } - } - } - }, - "responses": { - "201": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "Org Hook", - "description": "Org Hook", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1" - }, - "ping_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1/pings" - }, - "name": { - "type": "string", - "example": "web" - }, - "events": { - "type": "array", - "example": [ - "push", - "pull_request" - ], - "items": { - "type": "string" - } - }, - "active": { - "type": "boolean", - "example": true - }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "example": "\"http://example.com/2\"" - }, - "insecure_ssl": { - "type": "string", - "example": "\"0\"" - }, - "content_type": { - "type": "string", - "example": "\"form\"" - }, - "secret": { - "type": "string", - "example": "\"********\"" - } - } - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-09-06T20:39:23Z" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-09-06T17:26:27Z" - }, - "type": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "type", - "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "url": "https://api.github.com/orgs/octocat/hooks/1", - "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", - "name": "web", - "events": [ - "push", - "pull_request" - ], - "active": true, - "config": { - "url": "http://example.com", - "content_type": "json" - }, - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "type": "Organization" - } - } - } - } - }, - "headers": { - "Location": { - "example": "https://api.github.com/orgs/octocat/hooks/1", - "schema": { - "type": "string" - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, - "404": { - "description": "Resource Not Found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } + "examples": { + "selected_actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "previews": [ ], - "category": "orgs", - "subcategory": "webhooks" + "category": "actions", + "subcategory": "permissions" } } }, - "/orgs/{org}/hooks/{hook_id}": { - "get": { - "summary": "Get an organization webhook", - "description": "Returns a webhook configured in an organization. To get only the webhook `config` properties, see \"[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization).\"", + "/orgs/{org}/actions/runner-groups": { + "post": { + "summary": "Create a self-hosted runner group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud and GitHub Enterprise Server. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nCreates a new self-hosted runner group for an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/create-self-hosted-runner-group-for-org", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/get-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#get-an-organization-webhook" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#create-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { @@ -38088,145 +38487,122 @@ "schema": { "type": "string" } - }, - { - "name": "hook_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or limit access to private repositories. Can be one of: `all`, `selected`, or `private`.", + "type": "string", + "enum": [ + "selected", + "all", + "private" + ], + "default": "all" + }, + "selected_repository_ids": { + "description": "List of repository IDs that can access the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the repository." + } + }, + "runners": { + "description": "List of runner IDs to add to the runner group.", + "type": "array", + "items": { + "type": "integer", + "description": "Unique identifier of the runner." + } + } + }, + "required": [ + "name" + ] + }, + "example": { + "name": "Expensive hardware runners", + "visibility": "selected", + "selected_repository_ids": [ + 32, + 91 + ], + "runners": [ + 9, + 2 + ] + } + } + } + }, "responses": { - "200": { + "201": { "description": "response", "content": { "application/json": { "schema": { - "title": "Org Hook", - "description": "Org Hook", "type": "object", "properties": { "id": { - "type": "integer", - "example": 1 - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1" - }, - "ping_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1/pings" + "type": "number" }, "name": { - "type": "string", - "example": "web" + "type": "string" }, - "events": { - "type": "array", - "example": [ - "push", - "pull_request" - ], - "items": { - "type": "string" - } + "visibility": { + "type": "string" }, - "active": { - "type": "boolean", - "example": true + "default": { + "type": "boolean" }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "example": "\"http://example.com/2\"" - }, - "insecure_ssl": { - "type": "string", - "example": "\"0\"" - }, - "content_type": { - "type": "string", - "example": "\"form\"" - }, - "secret": { - "type": "string", - "example": "\"********\"" - } - } + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-09-06T20:39:23Z" + "runners_url": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-09-06T17:26:27Z" + "inherited": { + "type": "boolean" }, - "type": { - "type": "string" + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" } }, "required": [ "id", - "url", - "type", "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at" + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" ] }, "examples": { "default": { "value": { - "id": 1, - "url": "https://api.github.com/orgs/octocat/hooks/1", - "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", - "name": "web", - "events": [ - "push", - "pull_request" - ], - "active": true, - "config": { - "url": "http://example.com", - "content_type": "json" - }, - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "type": "Organization" - } - } - } - } - } - }, - "404": { - "description": "Resource Not Found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "inherited": false, + "allows_public_repositories": true } } } @@ -38235,25 +38611,27 @@ } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "previews": [ ], - "category": "orgs", - "subcategory": "webhooks" + "category": "actions", + "subcategory": "self-hosted-runner-groups" } - }, + } + }, + "/orgs/{org}/actions/runner-groups/{runner_group_id}": { "patch": { - "summary": "Update an organization webhook", - "description": "Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization).\"", + "summary": "Update a self-hosted runner group for an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nUpdates the `name` and `visibility` of a self-hosted runner group in an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/update-self-hosted-runner-group-for-org", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/update-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#update-an-organization-webhook" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#update-a-self-hosted-runner-group-for-an-organization" }, "parameters": [ { @@ -38265,7 +38643,8 @@ } }, { - "name": "hook_id", + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", "in": "path", "required": true, "schema": { @@ -38279,62 +38658,24 @@ "schema": { "type": "object", "properties": { - "config": { - "type": "object", - "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/github-ae@latest/rest/reference/orgs#update-hook-config-params).", - "properties": { - "url": { - "type": "string", - "description": "The URL to which the payloads will be delivered.", - "example": "https://example.com/webhook", - "format": "uri" - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "example": "\"json\"" - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "example": "\"********\"" - }, - "insecure_ssl": { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "example": "\"0\"" - } - }, - "required": [ - "url" - ] - }, - "events": { - "type": "array", - "description": "Determines what [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) the hook is triggered for.", - "default": [ - "push" - ], - "items": { - "type": "string" - } - }, - "active": { - "type": "boolean", - "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", - "default": true - }, "name": { + "description": "Name of the runner group.", + "type": "string" + }, + "visibility": { + "description": "Visibility of a runner group. You can select all repositories, select individual repositories, or all private repositories. Can be one of: `all`, `selected`, or `private`.", "type": "string", - "example": "\"web\"" + "enum": [ + "selected", + "all", + "private" + ] } } }, "example": { - "active": true, - "events": [ - "pull_request" - ] + "name": "Expensive hardware runners", + "visibility": "selected" } } } @@ -38345,199 +38686,303 @@ "content": { "application/json": { "schema": { - "title": "Org Hook", - "description": "Org Hook", "type": "object", "properties": { "id": { - "type": "integer", - "example": 1 - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1" - }, - "ping_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/hooks/1/pings" + "type": "number" }, "name": { - "type": "string", - "example": "web" + "type": "string" }, - "events": { - "type": "array", - "example": [ - "push", - "pull_request" - ], - "items": { - "type": "string" - } + "visibility": { + "type": "string" }, - "active": { - "type": "boolean", - "example": true + "default": { + "type": "boolean" }, - "config": { - "type": "object", - "properties": { - "url": { - "type": "string", - "example": "\"http://example.com/2\"" - }, - "insecure_ssl": { - "type": "string", - "example": "\"0\"" - }, - "content_type": { - "type": "string", - "example": "\"form\"" - }, - "secret": { - "type": "string", - "example": "\"********\"" - } - } + "selected_repositories_url": { + "description": "Link to the selected repositories resource for this runner group. Not present unless visibility was set to `selected`", + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-09-06T20:39:23Z" + "runners_url": { + "type": "string" }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-09-06T17:26:27Z" + "inherited": { + "type": "boolean" }, - "type": { - "type": "string" + "inherited_allows_public_repositories": { + "type": "boolean" + }, + "allows_public_repositories": { + "type": "boolean" } }, "required": [ "id", - "url", - "type", "name", - "active", - "events", - "config", - "ping_url", - "created_at", - "updated_at" + "visibility", + "default", + "runners_url", + "inherited", + "allows_public_repositories" ] }, "examples": { "default": { "value": { - "id": 1, - "url": "https://api.github.com/orgs/octocat/hooks/1", - "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", - "name": "web", - "events": [ - "pull_request" - ], - "active": true, - "config": { - "url": "http://example.com", - "content_type": "json" - }, - "updated_at": "2011-09-06T20:39:23Z", - "created_at": "2011-09-06T17:26:27Z", - "type": "Organization" + "id": 2, + "name": "octo-runner-group", + "visibility": "selected", + "default": false, + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/runner-groups/2/repositories", + "runners_url": "https://api.github.com/orgs/octo-org/actions/runner_groups/2/runners", + "inherited": false, + "allows_public_repositories": true } } } } } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + }, + "delete": { + "summary": "Delete a self-hosted runner group from an organization", + "description": "The self-hosted runner groups REST API is available with GitHub Enterprise Cloud. For more information, see \"[GitHub's products](https://docs.github.com/github/getting-started-with-github/githubs-products).\"\n\nDeletes a self-hosted runner group for an organization.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "operationId": "actions/delete-self-hosted-runner-group-from-org", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-a-self-hosted-runner-group-from-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, - "422": { - "description": "Validation Failed", + { + "name": "runner_group_id", + "description": "Unique identifier of the self-hosted runner group.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runner-groups" + } + } + }, + "/orgs/{org}/actions/runners/{runner_id}": { + "delete": { + "summary": "Delete a self-hosted runner from an organization", + "description": "Forces the removal of a self-hosted runner from an organization. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `admin:org` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-self-hosted-runner-from-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-a-self-hosted-runner-from-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/orgs/{org}/actions/secrets": { + "get": { + "summary": "List organization secrets", + "description": "Lists all secrets available in an organization without revealing their encrypted values. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-org-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-organization-secrets" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", "type": "object", "required": [ - "message", - "documentation_url" + "total_count", + "secrets" ], "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "total_count": { + "type": "integer" }, - "errors": { + "secrets": { "type": "array", "items": { + "title": "Actions Secret for an Organization", + "description": "Secrets for GitHub Actions for an organization.", "type": "object", - "required": [ - "code" - ], "properties": { - "resource": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", "type": "string" }, - "field": { - "type": "string" + "created_at": { + "type": "string", + "format": "date-time" }, - "message": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time" }, - "code": { + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], "type": "string" }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] + "selected_repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" } - } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] } } } + }, + "examples": { + "default": { + "value": { + "total_count": 3, + "secrets": [ + { + "name": "GIST_ID", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "private" + }, + { + "name": "DEPLOY_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "all" + }, + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" + } + ] + } + } } } - } - }, - "404": { - "description": "Resource Not Found", - "content": { - "application/json": { + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } + "type": "string" } } } @@ -38549,20 +38994,22 @@ "previews": [ ], - "category": "orgs", - "subcategory": "webhooks" + "category": "actions", + "subcategory": "secrets" } - }, - "delete": { - "summary": "Delete an organization webhook", - "description": "", + } + }, + "/orgs/{org}/actions/secrets/public-key": { + "get": { + "summary": "Get an organization public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/delete-webhook", + "operationId": "actions/get-org-public-key", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#delete-an-organization-webhook" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-organization-public-key" }, "parameters": [ { @@ -38572,34 +39019,55 @@ "schema": { "type": "string" } - }, - { - "name": "hook_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "responses": { - "204": { - "description": "Empty response" - }, - "404": { - "description": "Resource Not Found", + "200": { + "description": "response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "ActionsPublicKey", + "description": "The public key used for setting Actions Secrets.", "type": "object", "properties": { - "message": { - "type": "string" + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "example": "1234567" }, - "documentation_url": { - "type": "string" + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + }, + "id": { + "type": "integer", + "example": 2 + }, + "url": { + "type": "string", + "example": "https://api.github.com/user/keys/2" + }, + "title": { + "type": "string", + "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + }, + "created_at": { + "type": "string", + "example": "2011-01-26T19:01:12Z" + } + }, + "required": [ + "key_id", + "key" + ] + }, + "examples": { + "default": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" } } } @@ -38613,22 +39081,22 @@ "previews": [ ], - "category": "orgs", - "subcategory": "webhooks" + "category": "actions", + "subcategory": "secrets" } } }, - "/orgs/{org}/hooks/{hook_id}/config": { + "/orgs/{org}/actions/secrets/{secret_name}": { "get": { - "summary": "Get a webhook configuration for an organization", - "description": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook).\"\n\nAccess tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission.", + "summary": "Get an organization secret", + "description": "Gets a single organization secret without revealing its encrypted value. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/get-webhook-config-for-org", + "operationId": "actions/get-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#get-a-webhook-configuration-for-an-organization" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-organization-secret" }, "parameters": [ { @@ -38640,54 +39108,68 @@ } }, { - "name": "hook_id", + "name": "secret_name", + "description": "secret_name parameter", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], "responses": { "200": { - "description": "Default response", + "description": "response", "content": { "application/json": { "schema": { - "title": "Webhook Configuration", - "description": "Configuration object of the webhook", + "title": "Actions Secret for an Organization", + "description": "Secrets for GitHub Actions for an organization.", "type": "object", "properties": { - "url": { - "type": "string", - "description": "The URL to which the payloads will be delivered.", - "example": "https://example.com/webhook", - "format": "uri" + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" }, - "content_type": { + "created_at": { "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "example": "\"json\"" + "format": "date-time" }, - "secret": { + "updated_at": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "example": "\"********\"" + "format": "date-time" }, - "insecure_ssl": { + "visibility": { + "description": "Visibility of a secret", + "enum": [ + "all", + "private", + "selected" + ], + "type": "string" + }, + "selected_repositories_url": { "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "example": "\"0\"" + "format": "uri", + "example": "https://api.github.com/organizations/org/secrets/my_secret/repositories" } - } + }, + "required": [ + "name", + "created_at", + "updated_at", + "visibility" + ] }, "examples": { "default": { "value": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z", + "visibility": "selected", + "selected_repositories_url": "https://api.github.com/orgs/octo-org/actions/secrets/SUPER_SECRET/repositories" } } } @@ -38701,20 +39183,20 @@ "previews": [ ], - "category": "orgs", - "subcategory": "webhooks" + "category": "actions", + "subcategory": "secrets" } }, - "patch": { - "summary": "Update a webhook configuration for an organization", - "description": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook).\"\n\nAccess tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission.", + "put": { + "summary": "Create or update an organization secret", + "description": "Creates or updates an organization secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to\nuse this endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/update-webhook-config-for-org", + "operationId": "actions/create-or-update-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#update-a-webhook-configuration-for-an-organization" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret" }, "parameters": [ { @@ -38726,11 +39208,12 @@ } }, { - "name": "hook_id", + "name": "secret_name", + "description": "secret_name parameter", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], @@ -38740,83 +39223,51 @@ "schema": { "type": "object", "properties": { - "url": { + "encrypted_value": { "type": "string", - "description": "The URL to which the payloads will be delivered.", - "example": "https://example.com/webhook", - "format": "uri" + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an organization public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-organization-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" }, - "content_type": { + "key_id": { "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "example": "\"json\"" + "description": "ID of the key you used to encrypt the secret." }, - "secret": { + "visibility": { "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "example": "\"********\"" + "description": "Configures the access that repositories have to the organization secret. Can be one of: \n\\- `all` - All repositories in an organization can access the secret. \n\\- `private` - Private repositories in an organization can access the secret. \n\\- `selected` - Only specific repositories can access the secret.", + "enum": [ + "all", + "private", + "selected" + ] }, - "insecure_ssl": { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "example": "\"0\"" + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can manage the list of selected repositories using the [List selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#list-selected-repositories-for-an-organization-secret), [Set selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret), and [Remove selected repository from an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "string" + } } - }, - "example": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" } + }, + "example": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678", + "visibility": "selected", + "selected_repository_ids": [ + "1296269", + "1296280" + ] } } } }, "responses": { - "200": { - "description": "Default response", - "content": { - "application/json": { - "schema": { - "title": "Webhook Configuration", - "description": "Configuration object of the webhook", - "type": "object", - "properties": { - "url": { - "type": "string", - "description": "The URL to which the payloads will be delivered.", - "example": "https://example.com/webhook", - "format": "uri" - }, - "content_type": { - "type": "string", - "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", - "example": "\"json\"" - }, - "secret": { - "type": "string", - "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", - "example": "\"********\"" - }, - "insecure_ssl": { - "type": "string", - "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", - "example": "\"0\"" - } - } - }, - "examples": { - "default": { - "value": { - "content_type": "json", - "insecure_ssl": "0", - "secret": "********", - "url": "https://example.com/webhook" - } - } - } - } - } + "201": { + "description": "Response when creating a secret" + }, + "204": { + "description": "Response when updating a secret" } }, "x-github": { @@ -38825,22 +39276,20 @@ "previews": [ ], - "category": "orgs", - "subcategory": "webhooks" + "category": "actions", + "subcategory": "secrets" } - } - }, - "/orgs/{org}/hooks/{hook_id}/pings": { - "post": { - "summary": "Ping an organization webhook", - "description": "This will trigger a [ping event](https://docs.github.com/github-ae@latest/webhooks/#ping-event) to be sent to the hook.", + }, + "delete": { + "summary": "Delete an organization secret", + "description": "Deletes a secret in an organization using the secret name. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", "tags": [ - "orgs" + "actions" ], - "operationId": "orgs/ping-webhook", + "operationId": "actions/delete-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#ping-an-organization-webhook" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-an-organization-secret" }, "parameters": [ { @@ -38852,37 +39301,18 @@ } }, { - "name": "hook_id", + "name": "secret_name", + "description": "secret_name parameter", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], "responses": { "204": { "description": "Empty response" - }, - "404": { - "description": "Resource Not Found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } } }, "x-github": { @@ -38891,22 +39321,22 @@ "previews": [ ], - "category": "orgs", - "subcategory": "webhooks" + "category": "actions", + "subcategory": "secrets" } } }, - "/orgs/{org}/installation": { + "/orgs/{org}/actions/secrets/{secret_name}/repositories": { "get": { - "summary": "Get an organization installation for the authenticated app", - "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "summary": "List selected repositories for an organization secret", + "description": "Lists all repositories that have been selected when the `visibility` for repository access to a secret is set to `selected`. You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", "tags": [ - "apps" + "actions" ], - "operationId": "apps/get-org-installation", + "operationId": "actions/list-selected-repos-for-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/apps/#get-an-organization-installation-for-the-authenticated-app" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-selected-repositories-for-an-organization-secret" }, "parameters": [ { @@ -38916,6 +39346,15 @@ "schema": { "type": "string" } + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } } ], "responses": { @@ -38924,590 +39363,42 @@ "content": { "application/json": { "schema": { - "title": "Installation", - "description": "Installation", "type": "object", + "required": [ + "total_count", + "repositories" + ], "properties": { - "id": { - "description": "The ID of the installation.", - "type": "integer", - "example": 1 + "total_count": { + "type": "integer" }, - "account": { - "nullable": true, - "anyOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - { - "title": "Enterprise", - "description": "An enterprise account", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] - } - ] - }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", - "type": "string", - "enum": [ - "all", - "selected" - ] - }, - "access_tokens_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/installations/1/access_tokens" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/installation/repositories" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/organizations/github/settings/installations/1" - }, - "app_id": { - "type": "integer", - "example": 1 - }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" - }, - "target_type": { - "type": "string", - "example": "Organization" - }, - "permissions": { - "type": "object", - "example": { - "issues": "read", - "deployments": "write" - }, - "properties": { - "deployments": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "pull_requests": { - "type": "string" - }, - "statuses": { - "type": "string" - }, - "issues": { - "type": "string", - "example": "\"read\"" - }, - "organization_administration": { - "type": "string", - "example": "\"read\"" - } - } - }, - "events": { - "type": "array", - "items": { - "type": "string" - } - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "single_file_name": { - "type": "string", - "example": "config.yaml", - "nullable": true - }, - "has_multiple_single_files": { - "type": "boolean", - "example": true - }, - "single_file_paths": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] - }, - "app_slug": { - "type": "string", - "example": "github-actions" - }, - "suspended_by": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "suspended_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "contact_email": { - "type": "string", - "example": "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"", - "nullable": true - } - }, - "required": [ - "id", - "app_id", - "app_slug", - "target_id", - "target_type", - "single_file_name", - "repository_selection", - "access_tokens_url", - "html_url", - "repositories_url", - "events", - "account", - "permissions", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "account": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "avatar_url": "https://github.com/images/error/hubot_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/orgs/github", - "html_url": "https://github.com/github", - "followers_url": "https://api.github.com/users/github/followers", - "following_url": "https://api.github.com/users/github/following{/other_user}", - "gists_url": "https://api.github.com/users/github/gists{/gist_id}", - "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/github/subscriptions", - "organizations_url": "https://api.github.com/users/github/orgs", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "received_events_url": "https://api.github.com/users/github/received_events", - "type": "Organization", - "site_admin": false - }, - "repository_selection": "all", - "access_tokens_url": "https://api.github.com/installations/1/access_tokens", - "repositories_url": "https://api.github.com/installation/repositories", - "html_url": "https://github.com/organizations/github/settings/installations/1", - "app_id": 1, - "target_id": 1, - "target_type": "Organization", - "permissions": { - "checks": "write", - "metadata": "read", - "contents": "read" - }, - "events": [ - "push", - "pull_request" - ], - "created_at": "2018-02-09T20:51:14Z", - "updated_at": "2018-02-09T20:51:14Z", - "single_file_name": "config.yml", - "has_multiple_single_files": true, - "single_file_paths": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ], - "app_slug": "github-actions" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "previews": [ - - ], - "category": "apps", - "subcategory": null - } - } - }, - "/orgs/{org}/installations": { - "get": { - "summary": "List app installations for an organization", - "description": "Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint.", - "tags": [ - "orgs" - ], - "operationId": "orgs/list-app-installations", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs/#list-app-installations-for-an-organization" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "installations" - ], - "properties": { - "total_count": { - "type": "integer" - }, - "installations": { + "repositories": { "type": "array", "items": { - "title": "Installation", - "description": "Installation", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { "id": { - "description": "The ID of the installation.", "type": "integer", - "example": 1 + "example": 1296269 }, - "account": { + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "type": "object", "nullable": true, - "anyOf": [ + "allOf": [ { "title": "Simple User", "description": "Simple User", @@ -39619,330 +39510,1357 @@ "url" ], "nullable": true - }, - { - "title": "Enterprise", - "description": "An enterprise account", - "type": "object", - "properties": { - "description": { - "description": "A short description of the enterprise.", - "type": "string", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/enterprises/octo-business" - }, - "website_url": { - "description": "The enterprise's website URL.", - "type": "string", - "nullable": true, - "format": "uri" - }, - "id": { - "description": "Unique identifier of the enterprise", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the enterprise.", - "type": "string", - "example": "Octo Business" - }, - "slug": { - "description": "The slug url identifier for the enterprise.", - "type": "string", - "example": "octo-business" - }, - "created_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "nullable": true, - "format": "date-time", - "example": "2019-01-26T19:14:43Z" - }, - "avatar_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "id", - "node_id", - "name", - "slug", - "html_url", - "created_at", - "updated_at", - "avatar_url" - ] } ] }, - "repository_selection": { - "description": "Describe whether all repositories have been selected or there's a selection involved", + "private": { + "type": "boolean" + }, + "html_url": { "type": "string", - "enum": [ - "all", - "selected" - ] + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "access_tokens_url": { + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/installations/1/access_tokens" + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "repositories_url": { + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/installation/repositories" + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "html_url": { + "deployments_url": { "type": "string", "format": "uri", - "example": "https://github.com/organizations/github/settings/installations/1" + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "app_id": { - "type": "integer", - "example": 1 + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, - "target_id": { - "description": "The ID of the user or organization this token is being scoped to.", - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - "target_type": { + "forks_url": { "type": "string", - "example": "Organization" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - "permissions": { - "type": "object", - "example": { - "issues": "read", - "deployments": "write" - }, - "properties": { - "deployments": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "pull_requests": { - "type": "string" - }, - "statuses": { - "type": "string" - }, - "issues": { - "type": "string", - "example": "\"read\"" - }, - "organization_administration": { - "type": "string", - "example": "\"read\"" - } - } + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - "events": { - "type": "array", - "items": { - "type": "string" - } + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - "created_at": { + "git_tags_url": { "type": "string", - "format": "date-time" + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, - "updated_at": { + "git_url": { + "type": "string" + }, + "issue_comment_url": { "type": "string", - "format": "date-time" + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - "single_file_name": { + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { "type": "string", - "example": "config.yaml", "nullable": true }, - "has_multiple_single_files": { - "type": "boolean", - "example": true + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, - "single_file_paths": { + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { "type": "array", "items": { "type": "string" - }, - "example": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ] + } }, - "app_slug": { + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { "type": "string", - "example": "github-actions" + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true }, - "suspended_by": { + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "template_repository": { "nullable": true, + "type": "object", "allOf": [ { - "title": "Simple User", - "description": "Simple User", + "title": "Repository", + "description": "A git repository", "type": "object", "properties": { - "login": { - "type": "string", - "example": "octocat" - }, "id": { - "type": "integer", - "example": 1 + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "html_url": { + "name": { + "description": "The name of the repository.", "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "Team Environment" }, - "followers_url": { + "full_name": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "octocat/Hello-World" }, - "following_url": { + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "gists_url": { + "description": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "This your first repo!", + "nullable": true }, - "starred_url": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "subscriptions_url": { + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "organizations_url": { + "deployments_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "repos_url": { + "downloads_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - "received_events_url": { + "forks_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - "type": { + "git_commits_url": { "type": "string", - "example": "User" + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - "site_admin": { + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, "starred_at": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "example": "\"2020-07-09T00:17:42Z\"" } }, "required": [ - "avatar_url", + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] } ] }, - "suspended_at": { - "type": "string", - "format": "date-time", - "nullable": true + "temp_clone_token": { + "type": "string" }, - "contact_email": { - "type": "string", - "example": "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"", + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 } }, "required": [ - "id", - "app_id", - "app_slug", - "target_id", - "target_type", - "single_file_name", - "repository_selection", - "access_tokens_url", + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", - "repositories_url", - "events", - "account", - "permissions", - "created_at", - "updated_at" - ] - } + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } } } }, @@ -39950,94 +40868,174 @@ "default": { "value": { "total_count": 1, - "installations": [ + "repositories": [ { - "id": 25381, - "account": { - "login": "octo-org", - "id": 6811672, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", - "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", "gravatar_id": "", - "url": "https://api.github.com/users/octo-org", - "html_url": "https://github.com/octo-org", - "followers_url": "https://api.github.com/users/octo-org/followers", - "following_url": "https://api.github.com/users/octo-org/following{/other_user}", - "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", - "organizations_url": "https://api.github.com/users/octo-org/orgs", - "repos_url": "https://api.github.com/users/octo-org/repos", - "events_url": "https://api.github.com/users/octo-org/events{/privacy}", - "received_events_url": "https://api.github.com/users/octo-org/received_events", - "type": "Organization", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", "site_admin": false }, - "repository_selection": "selected", - "access_tokens_url": "https://api.github.com/app/installations/25381/access_tokens", - "repositories_url": "https://api.github.com/installation/repositories", - "html_url": "https://github.com/organizations/octo-org/settings/installations/25381", - "app_id": 2218, - "target_id": 6811672, - "target_type": "Organization", - "permissions": { - "deployments": "write", - "metadata": "read", - "pull_requests": "read", - "statuses": "read" - }, - "events": [ - "deployment", - "deployment_status" - ], - "created_at": "2017-05-16T08:47:09.000-07:00", - "updated_at": "2017-06-06T11:23:23.000-07:00", - "single_file_name": "config.yml", - "has_multiple_single_files": true, - "single_file_paths": [ - "config.yml", - ".github/issue_TEMPLATE.md" - ], - "app_slug": "github-actions" + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" } ] } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Set selected repositories for an organization secret", + "description": "Replaces all repositories for an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/set-selected-repos-for-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "selected_repository_ids": { + "type": "array", + "description": "An array of repository ids that can access the organization secret. You can only provide a list of repository ids when the `visibility` is set to `selected`. You can add and remove individual repositories using the [Set selected repositories for an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#set-selected-repositories-for-an-organization-secret) and [Remove selected repository from an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret) endpoints.", + "items": { + "type": "integer" + } + } } + }, + "example": { + "selected_repository_ids": [ + 64780797 + ] } } } }, + "responses": { + "204": { + "description": "Empty response" + } + }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ ], - "category": "orgs", - "subcategory": null + "category": "actions", + "subcategory": "secrets" } } }, - "/orgs/{org}/issues": { - "get": { - "summary": "List organization issues assigned to the authenticated user", - "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests)\" endpoint.", + "/orgs/{org}/actions/secrets/{secret_name}/repositories/{repository_id}": { + "put": { + "summary": "Add selected repository to an organization secret", + "description": "Adds a repository to an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", "tags": [ - "issues" + "actions" ], - "operationId": "issues/list-for-org", + "operationId": "actions/add-selected-repo-to-org-secret", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/issues/#list-organization-issues-assigned-to-the-authenticated-user" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#add-selected-repository-to-an-organization-secret" }, "parameters": [ { @@ -40049,80 +41047,115 @@ } }, { - "name": "filter", - "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", - "in": "query", - "required": false, + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "assigned", - "created", - "mentioned", - "subscribed", - "all" - ], - "default": "assigned" + "type": "string" } }, { - "name": "state", - "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", - "in": "query", - "required": false, + "name": "repository_id", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" + "type": "integer" } + } + ], + "responses": { + "204": { + "description": "Response when repository was added to the selected list" }, + "409": { + "description": "Response when visibility type is not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Remove selected repository from an organization secret", + "description": "Removes a repository from an organization secret when the `visibility` for repository access is set to `selected`. The visibility is set when you [Create or update an organization secret](https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-organization-secret). You must authenticate using an access token with the `admin:org` scope to use this endpoint. GitHub Apps must have the `secrets` organization permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/remove-selected-repo-from-org-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#remove-selected-repository-from-an-organization-secret" + }, + "parameters": [ { - "name": "labels", - "description": "A list of comma separated label names. Example: `bug,ui,@high`", - "in": "query", - "required": false, + "name": "org", + "in": "path", + "required": true, "schema": { "type": "string" } }, { - "name": "sort", - "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", - "in": "query", - "required": false, + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "comments" - ], - "default": "created" + "type": "string" } }, { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "query", - "required": false, + "name": "repository_id", + "in": "path", + "required": true, "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" + "type": "integer" } + } + ], + "responses": { + "204": { + "description": "Response when repository was removed from the selected list" }, + "409": { + "description": "Response when visibility type not set to selected" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/orgs/{org}/events": { + "get": { + "summary": "List public organization events", + "description": "", + "tags": [ + "activity" + ], + "operationId": "activity/list-public-org-events", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/activity#list-public-organization-events" + }, + "parameters": [ { - "name": "since", - "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", - "in": "query", - "required": false, + "name": "org", + "in": "path", + "required": true, "schema": { "type": "string" } @@ -40154,512 +41187,172 @@ "schema": { "type": "array", "items": { - "title": "Issue", - "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "title": "Event", + "description": "Event", "type": "object", "properties": { "id": { - "type": "integer" - }, - "node_id": { "type": "string" }, - "url": { - "description": "URL for the issue", - "example": "https://api.github.com/repositories/42/issues/1", - "type": "string", - "format": "uri" - }, - "repository_url": { - "type": "string", - "format": "uri" - }, - "labels_url": { - "type": "string" - }, - "comments_url": { - "type": "string", - "format": "uri" - }, - "events_url": { - "type": "string", - "format": "uri" - }, - "html_url": { + "type": { "type": "string", - "format": "uri" - }, - "number": { - "description": "Number uniquely identifying the issue within its repository", - "example": 42, - "type": "integer" - }, - "state": { - "description": "State of the issue; either 'open' or 'closed'", - "example": "open", - "type": "string" + "nullable": true }, - "title": { - "description": "Title of the issue", - "example": "Widget creation fails in Safari on OS X 10.8", - "type": "string" + "actor": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": "string", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" + ] }, - "body": { - "description": "Contents of the issue", - "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", - "type": "string" + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "name": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "name", + "url" + ] }, - "user": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], + "org": { + "title": "Actor", + "description": "Actor", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "login": { + "type": "string" + }, + "display_login": { + "type": "string" + }, + "gravatar_id": { + "type": "string", "nullable": true + }, + "url": { + "type": "string", + "format": "uri" + }, + "avatar_url": { + "type": "string", + "format": "uri" } + }, + "required": [ + "id", + "login", + "gravatar_id", + "url", + "avatar_url" ] }, - "labels": { - "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", - "example": [ - "bug", - "registration" - ], - "type": "array", - "items": { - "oneOf": [ - { - "type": "string" - }, - { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "name": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "color": { - "type": "string", - "nullable": true - }, - "default": { - "type": "boolean" - } - } - } - ] - } - }, - "assignee": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", + "payload": { + "type": "object", + "properties": { + "action": { + "type": "string" + }, + "issue": { + "title": "Issue Simple", + "description": "Issue Simple", "type": "object", "properties": { - "login": { - "type": "string", - "example": "octocat" - }, "id": { "type": "integer", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MDU6SXNzdWUx" }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347" }, - "subscriptions_url": { + "repository_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "organizations_url": { + "labels_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}" }, - "repos_url": { + "comments_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments" }, "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "assignees": { - "type": "array", - "items": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "nullable": true - }, - "milestone": { - "nullable": true, - "allOf": [ - { - "title": "Milestone", - "description": "A collection of related issues and pull requests.", - "type": "object", - "properties": { - "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + "example": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events" }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World/milestones/v1.0" - }, - "labels_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + "example": "https://github.com/octocat/Hello-World/issues/1347" }, "number": { - "description": "The number of the milestone.", "type": "integer", - "example": 42 + "example": 1347 }, "state": { - "description": "The state of the milestone.", - "example": "open", "type": "string", - "enum": [ - "open", - "closed" - ], - "default": "open" + "example": "open" }, "title": { - "description": "The title of the milestone.", - "example": "v1.0", - "type": "string" + "type": "string", + "example": "Found a bug" }, - "description": { + "body": { "type": "string", - "example": "Tracking milestone for version 1.0", - "nullable": true + "example": "I'm having a problem with this." }, - "creator": { + "user": { "nullable": true, "allOf": [ { @@ -40776,1238 +41469,1884 @@ } ] }, - "open_issues": { - "type": "integer", - "example": 4 - }, - "closed_issues": { - "type": "integer", - "example": 8 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "closed_at": { - "type": "string", - "format": "date-time", - "example": "2013-02-12T13:22:01Z", - "nullable": true + "labels": { + "type": "array", + "items": { + "title": "Label", + "description": "Color-coded labels help you categorize and filter your issues (just like labels in Gmail).", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 208045946 + }, + "node_id": { + "type": "string", + "example": "MDU6TGFiZWwyMDgwNDU5NDY=" + }, + "url": { + "description": "URL for the label", + "example": "https://api.github.com/repositories/42/labels/bug", + "type": "string", + "format": "uri" + }, + "name": { + "description": "The name of the label.", + "example": "bug", + "type": "string" + }, + "description": { + "type": "string", + "example": "Something isn't working", + "nullable": true + }, + "color": { + "description": "6-character hex code, without the leading #, identifying the color", + "example": "FFFFFF", + "type": "string" + }, + "default": { + "type": "boolean", + "example": true + } + }, + "required": [ + "id", + "node_id", + "url", + "name", + "description", + "color", + "default" + ] + } }, - "due_on": { - "type": "string", - "format": "date-time", - "example": "2012-10-09T23:39:01Z", - "nullable": true - } - }, - "required": [ - "closed_issues", - "creator", - "description", - "due_on", - "closed_at", - "id", - "node_id", - "labels_url", - "html_url", - "number", - "open_issues", - "state", - "title", - "url", - "created_at", - "updated_at" - ] - } - ] - }, - "locked": { - "type": "boolean" - }, - "active_lock_reason": { - "type": "string", - "nullable": true - }, - "comments": { - "type": "integer" - }, - "pull_request": { - "type": "object", - "properties": { - "merged_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "diff_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "patch_url": { - "type": "string", - "format": "uri", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "nullable": true - } - }, - "required": [ - "diff_url", - "html_url", - "patch_url", - "url" - ] - }, - "closed_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time" - }, - "updated_at": { - "type": "string", - "format": "date-time" - }, - "closed_by": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "assignee": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, "nullable": true }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "milestone": { + "nullable": true, + "allOf": [ + { + "title": "Milestone", + "description": "A collection of related issues and pull requests.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" + }, + "labels_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" + }, + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 + }, + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" + }, + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" + }, + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "open_issues": { + "type": "integer", + "example": 4 + }, + "closed_issues": { + "type": "integer", + "example": 8 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "closed_at": { + "type": "string", + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true + }, + "due_on": { + "type": "string", + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "locked": { + "type": "boolean", + "example": true }, - "followers_url": { + "active_lock_reason": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "too heated", + "nullable": true }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "comments": { + "type": "integer", + "example": 0 }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] }, - "starred_url": { + "closed_at": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "format": "date-time", + "nullable": true }, - "subscriptions_url": { + "created_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "format": "date-time", + "example": "2011-04-22T13:33:48Z" }, - "organizations_url": { + "updated_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "format": "date-time", + "example": "2011-04-22T13:33:48Z" }, - "repos_url": { + "author_association": { + "title": "author_association", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "body_html": { + "type": "string" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "body_text": { + "type": "string" }, - "type": { + "timeline_url": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "format": "uri" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "body_html": { - "type": "string" - }, - "body_text": { - "type": "string" - }, - "timeline_url": { - "type": "string", - "format": "uri" - }, - "repository": { - "title": "Repository", - "description": "A git repository", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "nullable": true, - "allOf": [ - { - "title": "License Simple", - "description": "License Simple", + "repository": { + "title": "Repository", + "description": "A git repository", "type": "object", "properties": { - "key": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { "type": "string", - "example": "mit" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { + "description": "The name of the repository.", "type": "string", - "example": "MIT License" + "example": "Team Environment" }, - "url": { + "full_name": { "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" + "example": "octocat/Hello-World" }, - "spdx_id": { - "type": "string", + "license": { "nullable": true, - "example": "MIT" + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" + "forks": { + "type": "integer" }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] }, - "id": { - "type": "integer", - "example": 1 + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" }, - "avatar_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "example": "https://github.com/octocat/Hello-World" }, - "gravatar_id": { + "description": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", + "example": "This your first repo!", "nullable": true }, + "fork": { + "type": "boolean" + }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "html_url": { + "archive_url": { "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "followers_url": { + "assignees_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, - "following_url": { + "blobs_url": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - "gists_url": { + "branches_url": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - "starred_url": { + "collaborators_url": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - "subscriptions_url": { + "comments_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" }, - "organizations_url": { + "commits_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" }, - "repos_url": { + "compare_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" }, - "events_url": { + "contents_url": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" }, - "received_events_url": { + "contributors_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "type": { + "deployments_url": { "type": "string", - "example": "User" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "site_admin": { - "type": "boolean" + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, - "starred_at": { + "events_url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "template_repository": { - "nullable": true, - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - "id": { - "type": "integer" + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - "node_id": { - "type": "string" + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - "avatar_url": { - "type": "string" + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - "gravatar_id": { - "type": "string" + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, - "url": { - "type": "string" + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" }, - "html_url": { - "type": "string" + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - "followers_url": { - "type": "string" + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, - "following_url": { - "type": "string" + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, - "gists_url": { - "type": "string" + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, - "starred_url": { - "type": "string" + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, - "subscriptions_url": { - "type": "string" + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, - "organizations_url": { - "type": "string" + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, - "repos_url": { - "type": "string" + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, - "events_url": { - "type": "string" + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, - "received_events_url": { - "type": "string" + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, - "type": { - "type": "string" + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, - "site_admin": { - "type": "boolean" - } - } - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "language": { - "type": "string" - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" }, - "push": { + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { "type": "boolean" }, - "pull": { + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, "type": "boolean" - } - } - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "performed_via_github_app": { - "nullable": true, - "allOf": [ - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "owner": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, "type": "object", "properties": { - "login": { - "type": "string", + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "performed_via_github_app": { + "nullable": true, + "allOf": [ + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "example": 5, + "type": "integer" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "client_secret": { + "type": "string", + "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + }, + "webhook_secret": { + "type": "string", + "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + }, + "pem": { + "type": "string", + "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ], + "additionalProperties": true + } + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + }, + "comment": { + "title": "Issue Comment", + "description": "Comments provide a way for people to collaborate on an issue.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the issue comment", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue comment", + "example": "https://api.github.com/repositories/42/issues/comments/1", + "type": "string", + "format": "uri" + }, + "body": { + "description": "Contents of the issue comment", + "example": "What version of Safari were you using when you observed this bug?", + "type": "string" + }, + "body_text": { + "type": "string" + }, + "body_html": { + "type": "string" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "user": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", "example": "octocat" }, "id": { @@ -42115,496 +43454,395 @@ } ] }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, "created_at": { "type": "string", "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" + "example": "2011-04-14T16:00:49Z" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "example": 5, - "type": "integer" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" + "example": "2011-04-14T16:00:49Z" }, - "client_secret": { + "issue_url": { "type": "string", - "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + "format": "uri" }, - "webhook_secret": { + "author_association": { + "title": "author_association", "type": "string", - "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] }, - "pem": { - "type": "string", - "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ], - "additionalProperties": true - } - ] - }, - "author_association": { - "title": "author_association", - "type": "string", - "example": "OWNER", - "description": "How the author is associated with the repository.", - "enum": [ - "COLLABORATOR", - "CONTRIBUTOR", - "FIRST_TIMER", - "FIRST_TIME_CONTRIBUTOR", - "MANNEQUIN", - "MEMBER", - "NONE", - "OWNER" - ] - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "assignee", - "closed_at", - "comments", - "comments_url", - "events_url", - "html_url", - "id", - "node_id", - "labels", - "labels_url", - "milestone", - "number", - "repository_url", - "state", - "locked", - "title", - "url", - "user", - "author_association", - "created_at", - "updated_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "node_id": "MDU6SXNzdWUx", - "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", - "repository_url": "https://api.github.com/repos/octocat/Hello-World", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", - "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", - "html_url": "https://github.com/octocat/Hello-World/issues/1347", - "number": 1347, - "state": "open", - "title": "Found a bug", - "body": "I'm having a problem with this.", - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "labels": [ - { - "id": 208045946, - "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", - "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", - "name": "bug", - "description": "Something isn't working", - "color": "f29513", - "default": true - } - ], - "assignee": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "assignees": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ], - "milestone": { - "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", - "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", - "id": 1002604, - "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", - "number": 1, - "state": "open", - "title": "v1.0", - "description": "Tracking milestone for version 1.0", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "open_issues": 4, - "closed_issues": 8, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z", - "closed_at": "2013-02-12T13:22:01Z", - "due_on": "2012-10-09T23:39:01Z" - }, - "locked": true, - "active_lock_reason": "too heated", - "comments": 0, - "pull_request": { - "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", - "html_url": "https://github.com/octocat/Hello-World/pull/1347", - "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", - "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" - }, - "closed_at": null, - "created_at": "2011-04-22T13:33:48Z", - "updated_at": "2011-04-22T13:33:48Z", - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "template_repository": null, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://github.com/licenses/mit" + "performed_via_github_app": { + "nullable": true, + "allOf": [ + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "example": 5, + "type": "integer" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "client_secret": { + "type": "string", + "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + }, + "webhook_secret": { + "type": "string", + "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + }, + "pem": { + "type": "string", + "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ], + "additionalProperties": true + } + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "id", + "node_id", + "html_url", + "issue_url", + "author_association", + "user", + "url", + "created_at", + "updated_at" + ] }, - "forks": 1, - "open_issues": 1, - "watchers": 1 + "pages": { + "type": "array", + "items": { + "type": "object", + "properties": { + "page_name": { + "type": "string" + }, + "title": { + "type": "string" + }, + "summary": { + "type": "string", + "nullable": true + }, + "action": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "html_url": { + "type": "string" + } + } + } + } }, - "author_association": "COLLABORATOR" + "required": [ + "action" + ] + }, + "public": { + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Resource Not Found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" }, - "documentation_url": { - "type": "string" - } + "required": [ + "id", + "type", + "actor", + "repo", + "payload", + "public", + "created_at" + ] } } } @@ -42613,30 +43851,26 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": false, + "enabledForGitHubApps": true, "previews": [ - { - "required": false, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." - } + ], - "category": "issues", - "subcategory": null + "category": "activity", + "subcategory": "events" } } }, - "/orgs/{org}/members": { + "/orgs/{org}/hooks": { "get": { - "summary": "List organization members", - "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.", + "summary": "List organization webhooks", + "description": "", "tags": [ "orgs" ], - "operationId": "orgs/list-members", + "operationId": "orgs/list-webhooks", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#list-organization-members" + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#list-organization-webhooks" }, "parameters": [ { @@ -42647,35 +43881,6 @@ "type": "string" } }, - { - "name": "filter", - "description": "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. \n\\* `all` - All members the authenticated user can see.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "2fa_disabled", - "all" - ], - "default": "all" - } - }, - { - "name": "role", - "description": "Filter members returned by their role. Can be one of: \n\\* `all` - All members of the organization, regardless of role. \n\\* `admin` - Organization owners. \n\\* `member` - Non-owner organization members.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "admin", - "member" - ], - "default": "all" - } - }, { "name": "per_page", "description": "Results per page (max 100).", @@ -42703,140 +43908,111 @@ "schema": { "type": "array", "items": { - "title": "Simple User", - "description": "Simple User", + "title": "Org Hook", + "description": "Org Hook", "type": "object", "properties": { - "login": { - "type": "string", - "example": "octocat" - }, "id": { "type": "integer", "example": 1 }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "example": "https://api.github.com/orgs/octocat/hooks/1" }, - "followers_url": { + "ping_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "https://api.github.com/orgs/octocat/hooks/1/pings" }, - "starred_url": { + "name": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "web" }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "events": { + "type": "array", + "example": [ + "push", + "pull_request" + ], + "items": { + "type": "string" + } }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "active": { + "type": "boolean", + "example": true }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "config": { + "type": "object", + "properties": { + "url": { + "type": "string", + "example": "\"http://example.com/2\"" + }, + "insecure_ssl": { + "type": "string", + "example": "\"0\"" + }, + "content_type": { + "type": "string", + "example": "\"form\"" + }, + "secret": { + "type": "string", + "example": "\"********\"" + } + } }, - "events_url": { + "updated_at": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "date-time", + "example": "2011-09-06T20:39:23Z" }, - "received_events_url": { + "created_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "format": "date-time", + "example": "2011-09-06T17:26:27Z" }, "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "type": "string" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", + "url", "type", - "url" - ], - "nullable": true + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at" + ] } }, "examples": { "default": { "value": [ { - "login": "octocat", "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "name": "web", + "events": [ + "push", + "pull_request" + ], + "active": true, + "config": { + "url": "http://example.com", + "content_type": "json" + }, + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" } ] } @@ -42852,80 +44028,20 @@ } } }, - "302": { - "description": "Response if requester is not an organization member", - "headers": { - "Location": { - "example": "https://api.github.com/orgs/github/public_members", - "schema": { - "type": "string" - } - } - } - }, - "422": { - "description": "Validation Failed", + "404": { + "description": "Resource Not Found", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } } } } @@ -42940,21 +44056,19 @@ ], "category": "orgs", - "subcategory": "members" + "subcategory": "webhooks" } - } - }, - "/orgs/{org}/members/{username}": { - "get": { - "summary": "Check organization membership for a user", - "description": "Check if a user is, publicly or privately, a member of the organization.", + }, + "post": { + "summary": "Create an organization webhook", + "description": "Here's how you can create a hook that posts payloads in JSON format:", "tags": [ "orgs" ], - "operationId": "orgs/check-membership-for-user", + "operationId": "orgs/create-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#check-organization-membership-for-a-user" + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#create-an-organization-webhook" }, "parameters": [ { @@ -42964,941 +44078,213 @@ "schema": { "type": "string" } - }, - { - "name": "username", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], - "responses": { - "204": { - "description": "Response if requester is an organization member and user is a member" - }, - "302": { - "description": "Response if requester is not an organization member", - "headers": { - "Location": { - "example": "https://api.github.com/orgs/github/public_members/pezra", - "schema": { - "type": "string" + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Must be passed as \"web\"." + }, + "config": { + "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/github-ae@latest/rest/reference/orgs#create-hook-config-params).", + "properties": { + "url": { + "type": "string", + "description": "The URL to which the payloads will be delivered.", + "example": "https://example.com/webhook", + "format": "uri" + }, + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"json\"" + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "example": "\"********\"" + }, + "insecure_ssl": { + "type": "string", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "example": "\"0\"" + }, + "username": { + "type": "string", + "example": "\"kdaigle\"" + }, + "password": { + "type": "string", + "example": "\"password\"" + } + }, + "required": [ + "url" + ] + }, + "events": { + "type": "array", + "description": "Determines what [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) the hook is triggered for.", + "default": [ + "push" + ], + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "default": true + } + }, + "required": [ + "name", + "config" + ] + }, + "example": { + "name": "web", + "active": true, + "events": [ + "push", + "pull_request" + ], + "config": { + "url": "http://example.com/webhook", + "content_type": "json" } } } - }, - "404": { - "description": "Response if requester is an organization member and user is not a member" } }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - - ], - "category": "orgs", - "subcategory": "members" - } - }, - "delete": { - "summary": "Remove an organization member", - "description": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.", - "tags": [ - "orgs" - ], - "operationId": "orgs/remove-member", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#remove-an-organization-member" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], "responses": { - "204": { - "description": "Empty response" - }, - "403": { - "description": "Forbidden", + "201": { + "description": "response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Org Hook", + "description": "Org Hook", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "type": "integer", + "example": 1 }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - - ], - "category": "orgs", - "subcategory": "members" - } - } - }, - "/orgs/{org}/memberships/{username}": { - "get": { - "summary": "Get organization membership for a user", - "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", - "tags": [ - "orgs" - ], - "operationId": "orgs/get-membership-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#get-organization-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "Org Membership", - "description": "Org Membership", - "type": "object", - "properties": { "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/orgs/octocat/memberships/defunkt" + "example": "https://api.github.com/orgs/octocat/hooks/1" }, - "state": { + "ping_url": { "type": "string", - "example": "active" + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/pings" }, - "role": { + "name": { "type": "string", - "example": "admin" + "example": "web" }, - "organization_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat" + "events": { + "type": "array", + "example": [ + "push", + "pull_request" + ], + "items": { + "type": "string" + } }, - "organization": { - "title": "Organization Simple", - "description": "Organization Simple", + "active": { + "type": "boolean", + "example": true + }, + "config": { "type": "object", "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, "url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" + "example": "\"http://example.com/2\"" }, - "public_members_url": { + "insecure_ssl": { "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" + "example": "\"0\"" }, - "avatar_url": { + "content_type": { "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" + "example": "\"form\"" }, - "description": { + "secret": { "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "permissions": { - "type": "object", - "properties": { - "can_create_repository": { - "type": "boolean" + "example": "\"********\"" } - }, - "required": [ - "can_create_repository" - ] - } - }, - "required": [ - "state", - "role", - "organization_url", - "url", - "organization", - "user" - ] - }, - "examples": { - "response-if-user-has-an-active-admin-membership-with-organization": { - "summary": "Response if user has an active admin membership with organization", - "value": { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", - "role": "admin", - "organization_url": "https://api.github.com/orgs/octocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - }, - "response-if-user-has-an-active-membership-with-organization": { - "summary": "Response if user has an active membership with organization", - "value": { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", - "role": "member", - "organization_url": "https://api.github.com/orgs/octocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false } - } - }, - "response-if-user-has-a-pending-membership-with-organization": { - "summary": "Response if user has a pending membership with organization", - "value": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "member", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - } - } - } - } - }, - "404": { - "description": "Resource Not Found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - - ], - "category": "orgs", - "subcategory": "members" - } - }, - "put": { - "summary": "Set organization membership for a user", - "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/github-ae@latest/rest/reference/orgs#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", - "tags": [ - "orgs" - ], - "operationId": "orgs/set-membership-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#set-organization-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "role": { - "type": "string", - "description": "The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.", - "enum": [ - "admin", - "member" - ], - "default": "member" - } - } - } - } - } - }, - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "Org Membership", - "description": "Org Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat/memberships/defunkt" - }, - "state": { - "type": "string", - "example": "active" }, - "role": { + "updated_at": { "type": "string", - "example": "admin" + "format": "date-time", + "example": "2011-09-06T20:39:23Z" }, - "organization_url": { + "created_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/octocat" - }, - "organization": { - "title": "Organization Simple", - "description": "Organization Simple", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description" - ] - }, - "user": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] + "format": "date-time", + "example": "2011-09-06T17:26:27Z" }, - "permissions": { - "type": "object", - "properties": { - "can_create_repository": { - "type": "boolean" - } - }, - "required": [ - "can_create_repository" - ] + "type": { + "type": "string" } }, "required": [ - "state", - "role", - "organization_url", + "id", "url", - "organization", - "user" + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at" ] }, "examples": { - "response-if-user-was-previously-unaffiliated-with-organization": { - "summary": "Response if user was previously unaffiliated with organization", - "value": { - "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", - "state": "pending", - "role": "admin", - "organization_url": "https://api.github.com/orgs/invitocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" - }, - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - }, - "response-if-user-already-had-membership-with-organization": { - "summary": "Response if user already had membership with organization", + "default": { "value": { - "url": "https://api.github.com/orgs/octocat/memberships/defunkt", - "state": "active", - "role": "admin", - "organization_url": "https://api.github.com/orgs/octocat", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization" + "id": 1, + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "name": "web", + "events": [ + "push", + "pull_request" + ], + "active": true, + "config": { + "url": "http://example.com", + "content_type": "json" }, - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" } } } } + }, + "headers": { + "Location": { + "example": "https://api.github.com/orgs/octocat/hooks/1", + "schema": { + "type": "string" + } + } } }, "422": { @@ -43970,8 +44356,8 @@ } } }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource Not Found", "content": { "application/json": { "schema": { @@ -43998,19 +44384,21 @@ ], "category": "orgs", - "subcategory": "members" + "subcategory": "webhooks" } - }, - "delete": { - "summary": "Remove organization membership for a user", - "description": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.", + } + }, + "/orgs/{org}/hooks/{hook_id}": { + "get": { + "summary": "Get an organization webhook", + "description": "Returns a webhook configured in an organization. To get only the webhook `config` properties, see \"[Get a webhook configuration for an organization](/rest/reference/orgs#get-a-webhook-configuration-for-an-organization).\"", "tags": [ "orgs" ], - "operationId": "orgs/remove-membership-for-user", + "operationId": "orgs/get-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#remove-organization-membership-for-a-user" + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#get-an-organization-webhook" }, "parameters": [ { @@ -44022,33 +44410,124 @@ } }, { - "name": "username", + "name": "hook_id", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], "responses": { - "204": { - "description": "Empty response" - }, - "403": { - "description": "Forbidden", + "200": { + "description": "response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Org Hook", + "description": "Org Hook", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "type": "integer", + "example": 1 }, - "documentation_url": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1" + }, + "ping_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/pings" + }, + "name": { + "type": "string", + "example": "web" + }, + "events": { + "type": "array", + "example": [ + "push", + "pull_request" + ], + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean", + "example": true + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string", + "example": "\"http://example.com/2\"" + }, + "insecure_ssl": { + "type": "string", + "example": "\"0\"" + }, + "content_type": { + "type": "string", + "example": "\"form\"" + }, + "secret": { + "type": "string", + "example": "\"********\"" + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T20:39:23Z" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T17:26:27Z" + }, + "type": { "type": "string" } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "name": "web", + "events": [ + "push", + "pull_request" + ], + "active": true, + "config": { + "url": "http://example.com", + "content_type": "json" + }, + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" + } } } } @@ -44082,21 +44561,19 @@ ], "category": "orgs", - "subcategory": "members" + "subcategory": "webhooks" } - } - }, - "/orgs/{org}/outside_collaborators": { - "get": { - "summary": "List outside collaborators for an organization", - "description": "List all users who are outside collaborators of an organization.", + }, + "patch": { + "summary": "Update an organization webhook", + "description": "Updates a webhook configured in an organization. When you update a webhook, the `secret` will be overwritten. If you previously had a `secret` set, you must provide the same `secret` or set a new `secret` or the secret will be removed. If you are only updating individual webhook `config` properties, use \"[Update a webhook configuration for an organization](/rest/reference/orgs#update-a-webhook-configuration-for-an-organization).\"", "tags": [ "orgs" ], - "operationId": "orgs/list-outside-collaborators", + "operationId": "orgs/update-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#list-outside-collaborators-for-an-organization" + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#update-an-organization-webhook" }, "parameters": [ { @@ -44108,272 +44585,257 @@ } }, { - "name": "filter", - "description": "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. \n\\* `all`: All outside collaborators.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "2fa_disabled", - "all" - ], - "default": "all" - } - }, - { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", + "name": "hook_id", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "Simple User", + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "config": { "type": "object", + "description": "Key/value pairs to provide settings for this webhook. [These are defined below](https://docs.github.com/github-ae@latest/rest/reference/orgs#update-hook-config-params).", "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, "url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "description": "The URL to which the payloads will be delivered.", + "example": "https://example.com/webhook", + "format": "uri" }, - "received_events_url": { + "content_type": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"json\"" }, - "type": { + "secret": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "example": "\"********\"" }, - "starred_at": { + "insecure_ssl": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "example": "\"0\"" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", "url" - ], - "nullable": true - } - }, - "examples": { - "default": { - "value": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } ] + }, + "events": { + "type": "array", + "description": "Determines what [events](https://docs.github.com/github-ae@latest/webhooks/event-payloads) the hook is triggered for.", + "default": [ + "push" + ], + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean", + "description": "Determines if notifications are sent when the webhook is triggered. Set to `true` to send notifications.", + "default": true + }, + "name": { + "type": "string", + "example": "\"web\"" } } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } + }, + "example": { + "active": true, + "events": [ + "pull_request" + ] } } } }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - - ], - "category": "orgs", - "subcategory": "outside-collaborators" - } - } - }, - "/orgs/{org}/outside_collaborators/{username}": { - "put": { - "summary": "Convert an organization member to outside collaborator", - "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\".", - "tags": [ - "orgs" - ], - "operationId": "orgs/convert-member-to-outside-collaborator", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], "responses": { - "202": { - "description": "User is getting converted asynchronously" - }, - "204": { - "description": "User was converted" - }, - "403": { + "200": { "description": "response", "content": { "application/json": { "schema": { + "title": "Org Hook", + "description": "Org Hook", "type": "object", "properties": { - "message": { - "type": "string" + "id": { + "type": "integer", + "example": 1 }, - "documentation_url": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1" + }, + "ping_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/hooks/1/pings" + }, + "name": { + "type": "string", + "example": "web" + }, + "events": { + "type": "array", + "example": [ + "push", + "pull_request" + ], + "items": { + "type": "string" + } + }, + "active": { + "type": "boolean", + "example": true + }, + "config": { + "type": "object", + "properties": { + "url": { + "type": "string", + "example": "\"http://example.com/2\"" + }, + "insecure_ssl": { + "type": "string", + "example": "\"0\"" + }, + "content_type": { + "type": "string", + "example": "\"form\"" + }, + "secret": { + "type": "string", + "example": "\"********\"" + } + } + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T20:39:23Z" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-09-06T17:26:27Z" + }, + "type": { "type": "string" } - } + }, + "required": [ + "id", + "url", + "type", + "name", + "active", + "events", + "config", + "ping_url", + "created_at", + "updated_at" + ] }, "examples": { - "response-if-user-is-the-last-owner-of-the-organization": { - "summary": "Response if user is the last owner of the organization", + "default": { "value": { - "message": "Cannot convert the last owner to an outside collaborator", - "documentation_url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#convert-member-to-outside-collaborator" + "id": 1, + "url": "https://api.github.com/orgs/octocat/hooks/1", + "ping_url": "https://api.github.com/orgs/octocat/hooks/1/pings", + "name": "web", + "events": [ + "pull_request" + ], + "active": true, + "config": { + "url": "http://example.com", + "content_type": "json" + }, + "updated_at": "2011-09-06T20:39:23Z", + "created_at": "2011-09-06T17:26:27Z", + "type": "Organization" } - }, - "response-if-user-is-not-a-member-of-the-organization": { - "summary": "Response if user is not a member of the organization", - "value": { - "message": " is not a member of the organization.", - "documentation_url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#convert-member-to-outside-collaborator" + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } } } } @@ -44408,19 +44870,19 @@ ], "category": "orgs", - "subcategory": "outside-collaborators" + "subcategory": "webhooks" } }, "delete": { - "summary": "Remove outside collaborator from an organization", - "description": "Removing a user from this list will remove them from all the organization's repositories.", + "summary": "Delete an organization webhook", + "description": "", "tags": [ "orgs" ], - "operationId": "orgs/remove-outside-collaborator", + "operationId": "orgs/delete-webhook", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#remove-outside-collaborator-from-an-organization" + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#delete-an-organization-webhook" }, "parameters": [ { @@ -44432,11 +44894,11 @@ } }, { - "name": "username", + "name": "hook_id", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -44444,11 +44906,13 @@ "204": { "description": "Empty response" }, - "422": { - "description": "Response if user is a member of the organization", + "404": { + "description": "Resource Not Found", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { "message": { @@ -44458,14 +44922,6 @@ "type": "string" } } - }, - "examples": { - "response-if-user-is-a-member-of-the-organization": { - "value": { - "message": "You cannot specify an organization member to remove as an outside collaborator.", - "documentation_url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#remove-outside-collaborator" - } - } } } } @@ -44478,21 +44934,21 @@ ], "category": "orgs", - "subcategory": "outside-collaborators" + "subcategory": "webhooks" } } }, - "/orgs/{org}/projects": { + "/orgs/{org}/hooks/{hook_id}/config": { "get": { - "summary": "List organization projects", - "description": "Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "summary": "Get a webhook configuration for an organization", + "description": "Returns the webhook configuration for an organization. To get more information about the webhook, including the `active` state and `events`, use \"[Get an organization webhook ](/rest/reference/orgs#get-an-organization-webhook).\"\n\nAccess tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:read` permission.", "tags": [ - "projects" + "orgs" ], - "operationId": "projects/list-for-org", + "operationId": "orgs/get-webhook-config-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects/#list-organization-projects" + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#get-a-webhook-configuration-for-an-organization" }, "parameters": [ { @@ -44504,333 +44960,54 @@ } }, { - "name": "state", - "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "open", - "closed", - "all" - ], - "default": "open" - } - }, - { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", + "name": "hook_id", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], "responses": { "200": { - "description": "response", + "description": "Default response", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" - } + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", + "type": "object", + "properties": { + "url": { + "type": "string", + "description": "The URL to which the payloads will be delivered.", + "example": "https://example.com/webhook", + "format": "uri" }, - "required": [ - "id", - "node_id", - "number", - "name", - "body", - "state", - "url", - "html_url", - "owner_url", - "creator", - "columns_url", - "created_at", - "updated_at" - ] + "content_type": { + "type": "string", + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"json\"" + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "example": "\"********\"" + }, + "insecure_ssl": { + "type": "string", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "example": "\"0\"" + } } }, "examples": { "default": { - "value": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } + "value": { + "content_type": "json", + "insecure_ssl": "0", + "secret": "********", + "url": "https://example.com/webhook" } } } @@ -44842,26 +45019,22 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" - } + ], - "category": "projects", - "subcategory": null + "category": "orgs", + "subcategory": "webhooks" } }, - "post": { - "summary": "Create an organization project", - "description": "Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "patch": { + "summary": "Update a webhook configuration for an organization", + "description": "Updates the webhook configuration for an organization. To update more information about the webhook, including the `active` state and `events`, use \"[Update an organization webhook ](/rest/reference/orgs#update-an-organization-webhook).\"\n\nAccess tokens must have the `admin:org_hook` scope, and GitHub Apps must have the `organization_hooks:write` permission.", "tags": [ - "projects" + "orgs" ], - "operationId": "projects/create-for-org", + "operationId": "orgs/update-webhook-config-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects/#create-an-organization-project" + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#update-a-webhook-configuration-for-an-organization" }, "parameters": [ { @@ -44871,6 +45044,14 @@ "schema": { "type": "string" } + }, + { + "name": "hook_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } } ], "requestBody": { @@ -44879,87 +45060,202 @@ "schema": { "type": "object", "properties": { - "name": { + "url": { "type": "string", - "description": "The name of the project." + "description": "The URL to which the payloads will be delivered.", + "example": "https://example.com/webhook", + "format": "uri" }, - "body": { + "content_type": { "type": "string", - "description": "The description of the project." + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"json\"" + }, + "secret": { + "type": "string", + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "example": "\"********\"" + }, + "insecure_ssl": { + "type": "string", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "example": "\"0\"" } }, - "required": [ - "name" - ] - }, - "example": { - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year." + "example": { + "content_type": "json", + "insecure_ssl": "0", + "secret": "********", + "url": "https://example.com/webhook" + } } } } }, "responses": { - "201": { - "description": "response", + "200": { + "description": "Default response", "content": { "application/json": { "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", + "title": "Webhook Configuration", + "description": "Configuration object of the webhook", "type": "object", "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, "url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" + "description": "The URL to which the payloads will be delivered.", + "example": "https://example.com/webhook", + "format": "uri" }, - "html_url": { + "content_type": { "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" + "description": "The media type used to serialize the payloads. Supported values include `json` and `form`. The default is `form`.", + "example": "\"json\"" }, - "columns_url": { + "secret": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 + "description": "If provided, the `secret` will be used as the `key` to generate the HMAC hex digest value for [delivery signature headers](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#delivery-headers).", + "example": "\"********\"" }, - "node_id": { + "insecure_ssl": { "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", + "description": "Determines whether the SSL certificate of the host for `url` will be verified when delivering payloads. Supported values include `0` (verification is performed) and `1` (verification is not performed). The default is `0`. **We strongly recommend not setting this to `1` as you are subject to man-in-the-middle and other attacks.**", + "example": "\"0\"" + } + } + }, + "examples": { + "default": { + "value": { + "content_type": "json", + "insecure_ssl": "0", + "secret": "********", + "url": "https://example.com/webhook" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "orgs", + "subcategory": "webhooks" + } + } + }, + "/orgs/{org}/hooks/{hook_id}/pings": { + "post": { + "summary": "Ping an organization webhook", + "description": "This will trigger a [ping event](https://docs.github.com/github-ae@latest/webhooks/#ping-event) to be sent to the hook.", + "tags": [ + "orgs" + ], + "operationId": "orgs/ping-webhook", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#ping-an-organization-webhook" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "hook_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { "type": "string" }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "orgs", + "subcategory": "webhooks" + } + } + }, + "/orgs/{org}/installation": { + "get": { + "summary": "Get an organization installation for the authenticated app", + "description": "Enables an authenticated GitHub App to find the organization's installation information.\n\nYou must use a [JWT](https://docs.github.com/github-ae@latest/apps/building-github-apps/authenticating-with-github-apps/#authenticating-as-a-github-app) to access this endpoint.", + "tags": [ + "apps" + ], + "operationId": "apps/get-org-installation", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/apps/#get-an-organization-installation-for-the-authenticated-app" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Installation", + "description": "Installation", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", "type": "integer", "example": 1 }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { + "account": { "nullable": true, - "allOf": [ + "anyOf": [ { "title": "Simple User", "description": "Simple User", @@ -45071,46 +45367,326 @@ "url" ], "nullable": true + }, + { + "title": "Enterprise", + "description": "An enterprise account", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] } ] }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/installations/1/access_tokens" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/installation/repositories" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/organizations/github/settings/installations/1" + }, + "app_id": { + "type": "integer", + "example": 1 + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "example": "Organization" + }, + "permissions": { + "type": "object", + "example": { + "issues": "read", + "deployments": "write" + }, + "properties": { + "deployments": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "pull_requests": { + "type": "string" + }, + "statuses": { + "type": "string" + }, + "issues": { + "type": "string", + "example": "\"read\"" + }, + "organization_administration": { + "type": "string", + "example": "\"read\"" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, "created_at": { "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" + "format": "date-time" }, "updated_at": { "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" + "format": "date-time" }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "single_file_name": { "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" + "example": "config.yaml", + "nullable": true + }, + "has_multiple_single_files": { + "type": "boolean", + "example": true + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "config.yml", + ".github/issue_TEMPLATE.md" ] }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "app_slug": { + "type": "string", + "example": "github-actions" + }, + "suspended_by": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "suspended_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "contact_email": { + "type": "string", + "example": "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"", + "nullable": true } }, "required": [ "id", - "node_id", - "number", - "name", - "body", - "state", - "url", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", "html_url", - "owner_url", - "creator", - "columns_url", + "repositories_url", + "events", + "account", + "permissions", "created_at", "updated_at" ] @@ -45118,148 +45694,52 @@ "examples": { "default": { "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "login": "octocat", + "id": 1, + "account": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "avatar_url": "https://github.com/images/error/hubot_happy.gif", "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", + "url": "https://api.github.com/orgs/github", + "html_url": "https://github.com/github", + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z" - } - } - } - } - } - }, - "401": { - "description": "Requires Authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource Not Found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } + "repository_selection": "all", + "access_tokens_url": "https://api.github.com/installations/1/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/github/settings/installations/1", + "app_id": 1, + "target_id": 1, + "target_type": "Organization", + "permissions": { + "checks": "write", + "metadata": "read", + "contents": "read" + }, + "events": [ + "push", + "pull_request" + ], + "created_at": "2018-02-09T20:51:14Z", + "updated_at": "2018-02-09T20:51:14Z", + "single_file_name": "config.yml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "app_slug": "github-actions" } } } @@ -45269,30 +45749,26 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" - } + ], - "category": "projects", + "category": "apps", "subcategory": null } } }, - "/orgs/{org}/public_members": { + "/orgs/{org}/installations": { "get": { - "summary": "List public organization members", - "description": "Members of an organization can choose to have their membership publicized or not.", + "summary": "List app installations for an organization", + "description": "Lists all GitHub Apps in an organization. The installation count includes all GitHub Apps installed on repositories in the organization. You must be an organization owner with `admin:read` scope to use this endpoint.", "tags": [ "orgs" ], - "operationId": "orgs/list-public-members", + "operationId": "orgs/list-app-installations", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#list-public-organization-members" + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs/#list-app-installations-for-an-organization" }, "parameters": [ { @@ -45328,443 +45804,732 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - }, - "examples": { - "default": { - "value": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - - ], - "category": "orgs", - "subcategory": "members" - } - } - }, - "/orgs/{org}/public_members/{username}": { - "get": { - "summary": "Check public organization membership for a user", - "description": "", - "tags": [ - "orgs" - ], - "operationId": "orgs/check-public-membership-for-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#check-public-organization-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Response if user is a public member" - }, - "404": { - "description": "Response if user is not a public member" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - - ], - "category": "orgs", - "subcategory": "members" - } - }, - "put": { - "summary": "Set public organization membership for the authenticated user", - "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "tags": [ - "orgs" - ], - "operationId": "orgs/set-public-membership-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Empty response" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", + "required": [ + "total_count", + "installations" + ], "properties": { - "message": { - "type": "string" + "total_count": { + "type": "integer" }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "previews": [ - - ], - "category": "orgs", - "subcategory": "members" - } - }, - "delete": { - "summary": "Remove public organization membership for the authenticated user", - "description": "", - "tags": [ - "orgs" - ], - "operationId": "orgs/remove-public-membership-for-authenticated-user", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Empty response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "previews": [ - - ], - "category": "orgs", - "subcategory": "members" - } - } - }, - "/orgs/{org}/repos": { - "get": { - "summary": "List organization repositories", - "description": "Lists repositories for the specified organization.", - "tags": [ - "repos" - ], - "operationId": "repos/list-for-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#list-organization-repositories" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "type", - "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "public", - "private", - "forks", - "sources", - "member", - "internal" - ] - } - }, - { - "name": "sort", - "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "created", - "updated", - "pushed", - "full_name" - ], - "default": "created" - } - }, - { - "name": "direction", - "description": "Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc`", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ] - } - }, - { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { + "installations": { + "type": "array", + "items": { + "title": "Installation", + "description": "Installation", + "type": "object", + "properties": { + "id": { + "description": "The ID of the installation.", + "type": "integer", + "example": 1 + }, + "account": { + "nullable": true, + "anyOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + { + "title": "Enterprise", + "description": "An enterprise account", + "type": "object", + "properties": { + "description": { + "description": "A short description of the enterprise.", + "type": "string", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/enterprises/octo-business" + }, + "website_url": { + "description": "The enterprise's website URL.", + "type": "string", + "nullable": true, + "format": "uri" + }, + "id": { + "description": "Unique identifier of the enterprise", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the enterprise.", + "type": "string", + "example": "Octo Business" + }, + "slug": { + "description": "The slug url identifier for the enterprise.", + "type": "string", + "example": "octo-business" + }, + "created_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "nullable": true, + "format": "date-time", + "example": "2019-01-26T19:14:43Z" + }, + "avatar_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "id", + "node_id", + "name", + "slug", + "html_url", + "created_at", + "updated_at", + "avatar_url" + ] + } + ] + }, + "repository_selection": { + "description": "Describe whether all repositories have been selected or there's a selection involved", + "type": "string", + "enum": [ + "all", + "selected" + ] + }, + "access_tokens_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/installations/1/access_tokens" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/installation/repositories" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/organizations/github/settings/installations/1" + }, + "app_id": { + "type": "integer", + "example": 1 + }, + "target_id": { + "description": "The ID of the user or organization this token is being scoped to.", + "type": "integer" + }, + "target_type": { + "type": "string", + "example": "Organization" + }, + "permissions": { + "type": "object", + "example": { + "issues": "read", + "deployments": "write" + }, + "properties": { + "deployments": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "pull_requests": { + "type": "string" + }, + "statuses": { + "type": "string" + }, + "issues": { + "type": "string", + "example": "\"read\"" + }, + "organization_administration": { + "type": "string", + "example": "\"read\"" + } + } + }, + "events": { + "type": "array", + "items": { + "type": "string" + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "single_file_name": { + "type": "string", + "example": "config.yaml", + "nullable": true + }, + "has_multiple_single_files": { + "type": "boolean", + "example": true + }, + "single_file_paths": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ] + }, + "app_slug": { + "type": "string", + "example": "github-actions" + }, + "suspended_by": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "suspended_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "contact_email": { + "type": "string", + "example": "\"test_13f1e99741e3e004@d7e1eb0bc0a1ba12.com\"", + "nullable": true + } + }, + "required": [ + "id", + "app_id", + "app_slug", + "target_id", + "target_type", + "single_file_name", + "repository_selection", + "access_tokens_url", + "html_url", + "repositories_url", + "events", + "account", + "permissions", + "created_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "installations": [ + { + "id": 25381, + "account": { + "login": "octo-org", + "id": 6811672, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjY4MTE2NzI=", + "avatar_url": "https://avatars3.githubusercontent.com/u/6811672?v=4", + "gravatar_id": "", + "url": "https://api.github.com/users/octo-org", + "html_url": "https://github.com/octo-org", + "followers_url": "https://api.github.com/users/octo-org/followers", + "following_url": "https://api.github.com/users/octo-org/following{/other_user}", + "gists_url": "https://api.github.com/users/octo-org/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octo-org/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octo-org/subscriptions", + "organizations_url": "https://api.github.com/users/octo-org/orgs", + "repos_url": "https://api.github.com/users/octo-org/repos", + "events_url": "https://api.github.com/users/octo-org/events{/privacy}", + "received_events_url": "https://api.github.com/users/octo-org/received_events", + "type": "Organization", + "site_admin": false + }, + "repository_selection": "selected", + "access_tokens_url": "https://api.github.com/app/installations/25381/access_tokens", + "repositories_url": "https://api.github.com/installation/repositories", + "html_url": "https://github.com/organizations/octo-org/settings/installations/25381", + "app_id": 2218, + "target_id": 6811672, + "target_type": "Organization", + "permissions": { + "deployments": "write", + "metadata": "read", + "pull_requests": "read", + "statuses": "read" + }, + "events": [ + "deployment", + "deployment_status" + ], + "created_at": "2017-05-16T08:47:09.000-07:00", + "updated_at": "2017-06-06T11:23:23.000-07:00", + "single_file_name": "config.yml", + "has_multiple_single_files": true, + "single_file_paths": [ + "config.yml", + ".github/issue_TEMPLATE.md" + ], + "app_slug": "github-actions" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "orgs", + "subcategory": null + } + } + }, + "/orgs/{org}/issues": { + "get": { + "summary": "List organization issues assigned to the authenticated user", + "description": "List issues in an organization assigned to the authenticated user.\n\n**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this\nreason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by\nthe `pull_request` key. Be aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull\nrequest id, use the \"[List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests)\" endpoint.", + "tags": [ + "issues" + ], + "operationId": "issues/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/issues/#list-organization-issues-assigned-to-the-authenticated-user" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "filter", + "description": "Indicates which sorts of issues to return. Can be one of: \n\\* `assigned`: Issues assigned to you \n\\* `created`: Issues created by you \n\\* `mentioned`: Issues mentioning you \n\\* `subscribed`: Issues you're subscribed to updates for \n\\* `all`: All issues the authenticated user can see, regardless of participation or creation", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "assigned", + "created", + "mentioned", + "subscribed", + "all" + ], + "default": "assigned" + } + }, + { + "name": "state", + "description": "Indicates the state of the issues to return. Can be either `open`, `closed`, or `all`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + } + }, + { + "name": "labels", + "description": "A list of comma separated label names. Example: `bug,ui,@high`", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "sort", + "description": "What to sort results by. Can be either `created`, `updated`, `comments`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "comments" + ], + "default": "created" + } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "default": "desc" + } + }, + { + "name": "since", + "description": "Only show notifications updated after the given time. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Issue", + "description": "Issues are a great way to keep track of tasks, enhancements, and bugs for your projects.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "description": "URL for the issue", + "example": "https://api.github.com/repositories/42/issues/1", "type": "string", - "example": "octocat/Hello-World" + "format": "uri" }, - "owner": { - "type": "object", + "repository_url": { + "type": "string", + "format": "uri" + }, + "labels_url": { + "type": "string" + }, + "comments_url": { + "type": "string", + "format": "uri" + }, + "events_url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri" + }, + "number": { + "description": "Number uniquely identifying the issue within its repository", + "example": 42, + "type": "integer" + }, + "state": { + "description": "State of the issue; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "title": { + "description": "Title of the issue", + "example": "Widget creation fails in Safari on OS X 10.8", + "type": "string" + }, + "body": { + "description": "Contents of the issue", + "example": "It looks like the new widget form is broken on Safari. When I try and create the widget, Safari crashes. This is reproducible on 10.8, but not 10.9. Maybe a browser bug?", + "type": "string" + }, + "user": { "nullable": true, "allOf": [ { @@ -45881,393 +46646,340 @@ } ] }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { + "labels": { + "description": "Labels to associate with this issue; pass one or more label names to replace the set of labels on this issue; send an empty array to clear all labels from the issue; note that the labels are silently dropped for users without push access to the repository", + "example": [ + "bug", + "registration" + ], "type": "array", "items": { - "type": "string" + "oneOf": [ + { + "type": "string" + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "name": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "color": { + "type": "string", + "nullable": true + }, + "default": { + "type": "boolean" + } + } + } + ] } }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true + "assignee": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "push": { - "type": "boolean" + "assignees": { + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } }, - "pull": { - "type": "boolean" - } - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "nullable": true }, - "template_repository": { + "milestone": { "nullable": true, - "type": "object", "allOf": [ { - "title": "Repository", - "description": "A git repository", + "title": "Milestone", + "description": "A collection of related issues and pull requests.", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1" }, - "node_id": { + "html_url": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "format": "uri", + "example": "https://github.com/octocat/Hello-World/milestones/v1.0" }, - "name": { - "description": "The name of the repository.", + "labels_url": { "type": "string", - "example": "Team Environment" + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels" }, - "full_name": { + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { "type": "string", - "example": "octocat/Hello-World" + "example": "MDk6TWlsZXN0b25lMTAwMjYwNA==" }, - "license": { - "nullable": true, - "allOf": [ - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] + "number": { + "description": "The number of the milestone.", + "type": "integer", + "example": 42 }, - "forks": { - "type": "integer" + "state": { + "description": "The state of the milestone.", + "example": "open", + "type": "string", + "enum": [ + "open", + "closed" + ], + "default": "open" }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "title": { + "description": "The title of the milestone.", + "example": "v1.0", + "type": "string" }, - "owner": { + "description": { + "type": "string", + "example": "Tracking milestone for version 1.0", + "nullable": true + }, + "creator": { "nullable": true, "allOf": [ { @@ -46384,861 +47096,1561 @@ } ] }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + "open_issues": { + "type": "integer", + "example": 4 }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + "closed_issues": { + "type": "integer", + "example": 8 }, - "commits_url": { + "created_at": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + "format": "date-time", + "example": "2011-04-10T20:09:31Z" }, - "compare_url": { + "updated_at": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "format": "date-time", + "example": "2014-03-03T18:58:10Z" }, - "contents_url": { + "closed_at": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "format": "date-time", + "example": "2013-02-12T13:22:01Z", + "nullable": true }, - "contributors_url": { + "due_on": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { + "format": "date-time", + "example": "2012-10-09T23:39:01Z", + "nullable": true + } + }, + "required": [ + "closed_issues", + "creator", + "description", + "due_on", + "closed_at", + "id", + "node_id", + "labels_url", + "html_url", + "number", + "open_issues", + "state", + "title", + "url", + "created_at", + "updated_at" + ] + } + ] + }, + "locked": { + "type": "boolean" + }, + "active_lock_reason": { + "type": "string", + "nullable": true + }, + "comments": { + "type": "integer" + }, + "pull_request": { + "type": "object", + "properties": { + "merged_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "diff_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "patch_url": { + "type": "string", + "format": "uri", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "nullable": true + } + }, + "required": [ + "diff_url", + "html_url", + "patch_url", + "url" + ] + }, + "closed_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "closed_by": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + "example": "octocat" }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + "id": { + "type": "integer", + "example": 1 }, - "events_url": { + "node_id": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" + "example": "MDQ6VXNlcjE=" }, - "forks_url": { + "avatar_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "example": "https://github.com/images/error/octocat_happy.gif" }, - "labels_url": { + "gravatar_id": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "languages_url": { + "url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" + "example": "https://api.github.com/users/octocat" }, - "merges_url": { + "html_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" + "example": "https://github.com/octocat" }, - "stargazers_url": { + "followers_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "example": "https://api.github.com/users/octocat/followers" }, - "subscribers_url": { + "following_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "subscription_url": { + "gists_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "tags_url": { + "starred_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "teams_url": { + "subscriptions_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" + "example": "https://api.github.com/users/octocat/subscriptions" }, - "mirror_url": { + "organizations_url": { "type": "string", "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true + "example": "https://api.github.com/users/octocat/orgs" }, - "hooks_url": { + "repos_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + "example": "https://api.github.com/users/octocat/repos" }, - "svn_url": { + "events_url": { "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "homepage": { + "received_events_url": { "type": "string", "format": "uri", - "example": "https://github.com", - "nullable": true + "example": "https://api.github.com/users/octocat/received_events" }, - "language": { + "type": { "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 + "example": "User" }, - "size": { - "type": "integer", - "example": 108 + "site_admin": { + "type": "boolean" }, - "default_branch": { - "description": "The default branch of the repository.", + "starred_at": { "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "body_html": { + "type": "string" + }, + "body_text": { + "type": "string" + }, + "timeline_url": { + "type": "string", + "format": "uri" + }, + "repository": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { "type": "boolean" }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, + "pull": { "type": "boolean" }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true + "triage": { + "type": "boolean" }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true + "push": { + "type": "boolean" }, - "template_repository": { - "nullable": true, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { + "login": { + "type": "string", + "example": "octocat" + }, "id": { - "type": "integer" + "type": "integer", + "example": 1 }, "node_id": { - "type": "string" - }, - "name": { - "type": "string" + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "full_name": { - "type": "string" + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "private": { - "type": "boolean" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" }, "html_url": { - "type": "string" - }, - "description": { - "type": "string" + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, - "fork": { - "type": "boolean" + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "url": { - "type": "string" + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "archive_url": { - "type": "string" + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "contributors_url": { - "type": "string" + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "deployments_url": { - "type": "string" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "downloads_url": { - "type": "string" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" }, "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "releases_url": { - "type": "string" + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "ssh_url": { - "type": "string" + "type": { + "type": "string", + "example": "User" }, - "stargazers_url": { - "type": "string" + "site_admin": { + "type": "boolean" }, - "statuses_url": { + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { "type": "string" }, - "subscribers_url": { - "type": "string" + "id": { + "type": "integer" }, - "subscription_url": { + "node_id": { "type": "string" }, - "tags_url": { + "avatar_url": { "type": "string" }, - "teams_url": { + "gravatar_id": { "type": "string" }, - "trees_url": { + "url": { "type": "string" }, - "clone_url": { + "html_url": { "type": "string" }, - "mirror_url": { + "followers_url": { "type": "string" }, - "hooks_url": { + "following_url": { "type": "string" }, - "svn_url": { + "gists_url": { "type": "string" }, - "homepage": { + "starred_url": { "type": "string" }, - "language": { + "subscriptions_url": { "type": "string" }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { + "organizations_url": { "type": "string" }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { + "repos_url": { "type": "string" }, - "pushed_at": { + "events_url": { "type": "string" }, - "created_at": { + "received_events_url": { "type": "string" }, - "updated_at": { + "type": { "type": "string" }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "allow_rebase_merge": { + "site_admin": { "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { "type": "boolean" }, - "delete_branch_on_merge": { + "push": { "type": "boolean" }, - "allow_merge_commit": { + "pull": { "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" } } }, + "allow_rebase_merge": { + "type": "boolean" + }, "temp_clone_token": { "type": "string" }, "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true + "type": "boolean" }, "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false + "type": "boolean" }, "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true + "type": "boolean" }, "subscribers_count": { "type": "integer" }, "network_count": { "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - } - ] - }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" + } }, - "name": { + "temp_clone_token": { "type": "string" }, - "spdx_id": { - "type": "string" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true }, - "url": { - "type": "string" + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false }, - "node_id": { + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" } }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 - }, - "watchers": { - "type": "integer", - "example": 0 - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" - ] - } + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "performed_via_github_app": { + "nullable": true, + "allOf": [ + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "example": 5, + "type": "integer" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "client_secret": { + "type": "string", + "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + }, + "webhook_secret": { + "type": "string", + "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + }, + "pem": { + "type": "string", + "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ], + "additionalProperties": true + } + ] + }, + "author_association": { + "title": "author_association", + "type": "string", + "example": "OWNER", + "description": "How the author is associated with the repository.", + "enum": [ + "COLLABORATOR", + "CONTRIBUTOR", + "FIRST_TIMER", + "FIRST_TIME_CONTRIBUTOR", + "MANNEQUIN", + "MEMBER", + "NONE", + "OWNER" + ] + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "assignee", + "closed_at", + "comments", + "comments_url", + "events_url", + "html_url", + "id", + "node_id", + "labels", + "labels_url", + "milestone", + "number", + "repository_url", + "state", + "locked", + "title", + "url", + "user", + "author_association", + "created_at", + "updated_at" + ] + } }, "examples": { "default": { "value": [ { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { + "id": 1, + "node_id": "MDU6SXNzdWUx", + "url": "https://api.github.com/repos/octocat/Hello-World/issues/1347", + "repository_url": "https://api.github.com/repos/octocat/Hello-World", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/labels{/name}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/comments", + "events_url": "https://api.github.com/repos/octocat/Hello-World/issues/1347/events", + "html_url": "https://github.com/octocat/Hello-World/issues/1347", + "number": 1347, + "state": "open", + "title": "Found a bug", + "body": "I'm having a problem with this.", + "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -47258,88 +48670,113 @@ "type": "User", "site_admin": false }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" + "labels": [ + { + "id": 208045946, + "node_id": "MDU6TGFiZWwyMDgwNDU5NDY=", + "url": "https://api.github.com/repos/octocat/Hello-World/labels/bug", + "name": "bug", + "description": "Something isn't working", + "color": "f29513", + "default": true + } ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true + "assignee": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false }, - "template_repository": { + "assignees": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ], + "milestone": { + "url": "https://api.github.com/repos/octocat/Hello-World/milestones/1", + "html_url": "https://github.com/octocat/Hello-World/milestones/v1.0", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/milestones/1/labels", + "id": 1002604, + "node_id": "MDk6TWlsZXN0b25lMTAwMjYwNA==", + "number": 1, + "state": "open", + "title": "v1.0", + "description": "Tracking milestone for version 1.0", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "open_issues": 4, + "closed_issues": 8, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z", + "closed_at": "2013-02-12T13:22:01Z", + "due_on": "2012-10-09T23:39:01Z" + }, + "locked": true, + "active_lock_reason": "too heated", + "comments": 0, + "pull_request": { + "url": "https://api.github.com/repos/octocat/Hello-World/pulls/1347", + "html_url": "https://github.com/octocat/Hello-World/pull/1347", + "diff_url": "https://github.com/octocat/Hello-World/pull/1347.diff", + "patch_url": "https://github.com/octocat/Hello-World/pull/1347.patch" + }, + "closed_at": null, + "created_at": "2011-04-22T13:33:48Z", + "updated_at": "2011-04-22T13:33:48Z", + "repository": { "id": 1296269, "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World-Template", - "full_name": "octocat/Hello-World-Template", + "name": "Hello-World", + "full_name": "octocat/Hello-World", "owner": { "login": "octocat", "id": 1, @@ -47361,71 +48798,60 @@ "site_admin": false }, "private": false, - "html_url": "https://github.com/octocat/Hello-World-Template", + "html_url": "https://github.com/octocat/Hello-World", "description": "This your first repo!", "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World-Template", - "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World-Template.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World-Template.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World-Template.git", - "mirror_url": "git:git.example.com/octocat/Hello-World-Template", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", "homepage": "https://github.com", "language": null, - "forks": 9, "forks_count": 9, "stargazers_count": 80, "watchers_count": 80, - "watchers": 80, "size": 108, "default_branch": "master", - "open_issues": 0, "open_issues_count": 0, "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, "topics": [ "octocat", "atom", @@ -47449,13 +48875,26 @@ "pull": true }, "allow_rebase_merge": true, + "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", "allow_squash_merge": true, "delete_branch_on_merge": true, "allow_merge_commit": true, "subscribers_count": 42, - "network_count": 0 - } + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "author_association": "COLLABORATOR" } ] } @@ -47470,37 +48909,54 @@ } } } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "previews": [ { "required": false, - "name": "nebula", - "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" - }, - { - "required": false, - "name": "baptiste", - "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." } ], - "category": "repos", + "category": "issues", "subcategory": null } - }, - "post": { - "summary": "Create an organization repository", - "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + } + }, + "/orgs/{org}/members": { + "get": { + "summary": "List organization members", + "description": "List all users who are members of an organization. If the authenticated user is also a member of this organization then both concealed and public members will be returned.", "tags": [ - "repos" + "orgs" ], - "operationId": "repos/create-in-org", + "operationId": "orgs/list-members", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#create-an-organization-repository" + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#list-organization-members" }, "parameters": [ { @@ -47510,218 +48966,560 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository." - }, - "description": { - "type": "string", - "description": "A short description of the repository." - }, - "homepage": { - "type": "string", - "description": "A URL with more information about the repository." - }, - "private": { - "type": "boolean", - "description": "Either `true` to create a private repository or `false` to create a public one.", - "default": false - }, - "visibility": { - "type": "string", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", - "enum": [ - "public", - "private", - "visibility", - "internal" - ] - }, - "has_issues": { - "type": "boolean", - "description": "Either `true` to enable issues for this repository or `false` to disable them.", - "default": true - }, - "has_projects": { - "type": "boolean", - "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "default": true - }, - "has_wiki": { - "type": "boolean", - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "default": true - }, - "is_template": { - "type": "boolean", - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "default": false - }, - "team_id": { - "type": "integer", - "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization." - }, - "auto_init": { - "type": "boolean", - "description": "Pass `true` to create an initial commit with empty README.", - "default": false - }, - "gitignore_template": { - "type": "string", - "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\"." - }, - "license_template": { - "type": "string", - "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\"." - }, - "allow_squash_merge": { - "type": "boolean", - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "default": true - }, - "allow_merge_commit": { - "type": "boolean", - "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "default": true - }, - "allow_rebase_merge": { - "type": "boolean", - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "default": true - }, - "delete_branch_on_merge": { - "type": "boolean", - "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "default": false - } - }, - "required": [ - "name" - ] - }, - "example": { - "name": "Hello-World", - "description": "This is your first repository", - "homepage": "https://github.com", - "private": false, - "has_issues": true, - "has_projects": true, - "has_wiki": true - } + }, + { + "name": "filter", + "description": "Filter members returned in the list. Can be one of: \n\\* `2fa_disabled` - Members without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. Available for organization owners. \n\\* `all` - All members the authenticated user can see.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "2fa_disabled", + "all" + ], + "default": "all" + } + }, + { + "name": "role", + "description": "Filter members returned by their role. Can be one of: \n\\* `all` - All members of the organization, regardless of role. \n\\* `admin` - Organization owners. \n\\* `member` - Non-owner organization members.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "admin", + "member" + ], + "default": "all" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 } } - }, + ], "responses": { - "201": { + "200": { "description": "response", "content": { "application/json": { "schema": { - "title": "Repository", - "description": "A git repository", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "nullable": true, - "allOf": [ - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + }, + "examples": { + "default": { + "value": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "302": { + "description": "Response if requester is not an organization member", + "headers": { + "Location": { + "example": "https://api.github.com/orgs/github/public_members", + "schema": { + "type": "string" + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "orgs", + "subcategory": "members" + } + } + }, + "/orgs/{org}/members/{username}": { + "get": { + "summary": "Check organization membership for a user", + "description": "Check if a user is, publicly or privately, a member of the organization.", + "tags": [ + "orgs" + ], + "operationId": "orgs/check-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#check-organization-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response if requester is an organization member and user is a member" + }, + "302": { + "description": "Response if requester is not an organization member", + "headers": { + "Location": { + "example": "https://api.github.com/orgs/github/public_members/pezra", + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Response if requester is an organization member and user is not a member" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "orgs", + "subcategory": "members" + } + }, + "delete": { + "summary": "Remove an organization member", + "description": "Removing a user from this list will remove them from all teams and they will no longer have any access to the organization's repositories.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-member", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#remove-an-organization-member" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "orgs", + "subcategory": "members" + } + } + }, + "/orgs/{org}/memberships/{username}": { + "get": { + "summary": "Get organization membership for a user", + "description": "In order to get a user's membership with an organization, the authenticated user must be an organization member.", + "tags": [ + "orgs" + ], + "operationId": "orgs/get-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#get-organization-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Org Membership", + "description": "Org Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat/memberships/defunkt" + }, + "state": { + "type": "string", + "example": "active" + }, + "role": { + "type": "string", + "example": "admin" + }, + "organization_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/octocat" + }, + "organization": { + "title": "Organization Simple", + "description": "Organization Simple", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] + }, + "user": { "nullable": true, "allOf": [ { @@ -47838,762 +49636,523 @@ } ] }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true + "permissions": { + "type": "object", + "properties": { + "can_create_repository": { + "type": "boolean" + } + }, + "required": [ + "can_create_repository" + ] + } + }, + "required": [ + "state", + "role", + "organization_url", + "url", + "organization", + "user" + ] + }, + "examples": { + "response-if-user-has-an-active-admin-membership-with-organization": { + "summary": "Response if user has an active admin membership with organization", + "value": { + "url": "https://api.github.com/orgs/octocat/memberships/defunkt", + "state": "active", + "role": "admin", + "organization_url": "https://api.github.com/orgs/octocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "response-if-user-has-an-active-membership-with-organization": { + "summary": "Response if user has an active membership with organization", + "value": { + "url": "https://api.github.com/orgs/octocat/memberships/defunkt", + "state": "active", + "role": "member", + "organization_url": "https://api.github.com/orgs/octocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + }, + "response-if-user-has-a-pending-membership-with-organization": { + "summary": "Response if user has a pending membership with organization", + "value": { + "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", + "state": "pending", + "role": "member", + "organization_url": "https://api.github.com/orgs/invitocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "fork": { - "type": "boolean" + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "orgs", + "subcategory": "members" + } + }, + "put": { + "summary": "Set organization membership for a user", + "description": "Only authenticated organization owners can add a member to the organization or update the member's role.\n\n* If the authenticated user is _adding_ a member to the organization, the invited user will receive an email inviting them to the organization. The user's [membership status](https://docs.github.com/github-ae@latest/rest/reference/orgs#get-organization-membership-for-a-user) will be `pending` until they accept the invitation.\n \n* Authenticated users can _update_ a user's membership by passing the `role` parameter. If the authenticated user changes a member's role to `admin`, the affected user will receive an email notifying them that they've been made an organization owner. If the authenticated user changes an owner's role to `member`, no email will be sent.\n\n**Rate limits**\n\nTo prevent abuse, the authenticated user is limited to 50 organization invitations per 24 hour period. If the organization is more than one month old or on a paid plan, the limit is 500 invitations per 24 hour period.", + "tags": [ + "orgs" + ], + "operationId": "orgs/set-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#set-organization-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "type": "string", + "description": "The role to give the user in the organization. Can be one of: \n\\* `admin` - The user will become an owner of the organization. \n\\* `member` - The user will become a non-owner member of the organization.", + "enum": [ + "admin", + "member" + ], + "default": "member" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Org Membership", + "description": "Org Membership", + "type": "object", + "properties": { "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + "example": "https://api.github.com/orgs/octocat/memberships/defunkt" }, - "contents_url": { + "state": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + "example": "active" }, - "contributors_url": { + "role": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + "example": "admin" }, - "deployments_url": { + "organization_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + "example": "https://api.github.com/orgs/octocat" }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + "organization": { + "title": "Organization Simple", + "description": "Organization Simple", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description" + ] }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" + "user": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "template_repository": { - "nullable": true, + "permissions": { "type": "object", "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "language": { - "type": "string" - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_merge_commit": { + "can_create_repository": { "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" + }, + "required": [ + "can_create_repository" + ] } }, "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", + "state", + "role", + "organization_url", "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" + "organization", + "user" ] }, "examples": { - "default": { + "response-if-user-was-previously-unaffiliated-with-organization": { + "summary": "Response if user was previously unaffiliated with organization", "value": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { + "url": "https://api.github.com/orgs/invitocat/memberships/defunkt", + "state": "pending", + "role": "admin", + "organization_url": "https://api.github.com/orgs/invitocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -48612,131 +50171,50 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "template_repository": null, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 + } } - } - } - } - }, - "headers": { - "Location": { - "example": "https://api.github.com/repos/octocat/Hello-World", - "schema": { - "type": "string" - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + }, + "response-if-user-already-had-membership-with-organization": { + "summary": "Response if user already had membership with organization", + "value": { + "url": "https://api.github.com/orgs/octocat/memberships/defunkt", + "state": "active", + "role": "admin", + "organization_url": "https://api.github.com/orgs/octocat", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization" + }, + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } } } } @@ -48811,39 +50289,134 @@ } } } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": false, - "name": "nebula", - "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" - }, - { - "required": false, - "name": "baptiste", - "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" + + ], + "category": "orgs", + "subcategory": "members" + } + }, + "delete": { + "summary": "Remove organization membership for a user", + "description": "In order to remove a user's membership with an organization, the authenticated user must be an organization owner.\n\nIf the specified user is an active member of the organization, this will remove them from the organization. If the specified user has been invited to the organization, this will cancel their invitation. The specified user will receive an email notification in both cases.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#remove-organization-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + ], - "category": "repos", - "subcategory": null + "category": "orgs", + "subcategory": "members" } } }, - "/orgs/{org}/teams": { + "/orgs/{org}/outside_collaborators": { "get": { - "summary": "List teams", - "description": "Lists all teams in an organization that are visible to the authenticated user.", + "summary": "List outside collaborators for an organization", + "description": "List all users who are outside collaborators of an organization.", "tags": [ - "teams" + "orgs" ], - "operationId": "teams/list", + "operationId": "orgs/list-outside-collaborators", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#list-teams" + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#list-outside-collaborators-for-an-organization" }, "parameters": [ { @@ -48854,6 +50427,20 @@ "type": "string" } }, + { + "name": "filter", + "description": "Filter the list of outside collaborators. Can be one of: \n\\* `2fa_disabled`: Outside collaborators without [two-factor authentication](https://github.com/blog/1614-two-factor-authentication) enabled. \n\\* `all`: All outside collaborators.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "2fa_disabled", + "all" + ], + "default": "all" + } + }, { "name": "per_page", "description": "Results per page (max 100).", @@ -48881,144 +50468,611 @@ "schema": { "type": "array", "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { + "login": { + "type": "string", + "example": "octocat" + }, "id": { - "type": "integer" + "type": "integer", + "example": 1 }, "node_id": { - "type": "string" - }, - "name": { - "type": "string" + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "slug": { - "type": "string" + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "description": { + "gravatar_id": { "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "privacy": { - "type": "string" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "permission": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + }, + "examples": { + "default": { + "value": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "orgs", + "subcategory": "outside-collaborators" + } + } + }, + "/orgs/{org}/outside_collaborators/{username}": { + "put": { + "summary": "Convert an organization member to outside collaborator", + "description": "When an organization member is converted to an outside collaborator, they'll only have access to the repositories that their current team membership allows. The user will no longer be a member of the organization. For more information, see \"[Converting an organization member to an outside collaborator](https://help.github.com/articles/converting-an-organization-member-to-an-outside-collaborator/)\".", + "tags": [ + "orgs" + ], + "operationId": "orgs/convert-member-to-outside-collaborator", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#convert-an-organization-member-to-outside-collaborator" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "202": { + "description": "User is getting converted asynchronously" + }, + "204": { + "description": "User was converted" + }, + "403": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + }, + "examples": { + "response-if-user-is-the-last-owner-of-the-organization": { + "summary": "Response if user is the last owner of the organization", + "value": { + "message": "Cannot convert the last owner to an outside collaborator", + "documentation_url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#convert-member-to-outside-collaborator" + } + }, + "response-if-user-is-not-a-member-of-the-organization": { + "summary": "Response if user is not a member of the organization", + "value": { + "message": " is not a member of the organization.", + "documentation_url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#convert-member-to-outside-collaborator" + } + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "orgs", + "subcategory": "outside-collaborators" + } + }, + "delete": { + "summary": "Remove outside collaborator from an organization", + "description": "Removing a user from this list will remove them from all the organization's repositories.", + "tags": [ + "orgs" + ], + "operationId": "orgs/remove-outside-collaborator", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#remove-outside-collaborator-from-an-organization" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + }, + "422": { + "description": "Response if user is a member of the organization", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + }, + "examples": { + "response-if-user-is-a-member-of-the-organization": { + "value": { + "message": "You cannot specify an organization member to remove as an outside collaborator.", + "documentation_url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#remove-outside-collaborator" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "orgs", + "subcategory": "outside-collaborators" + } + } + }, + "/orgs/{org}/projects": { + "get": { + "summary": "List organization projects", + "description": "Lists the projects in an organization. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "tags": [ + "projects" + ], + "operationId": "projects/list-for-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects/#list-organization-projects" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "state", + "description": "Indicates the state of the projects to return. Can be either `open`, `closed`, or `all`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "open", + "closed", + "all" + ], + "default": "open" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", + "type": "object", + "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/api-playground/projects-test" }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/projects/1002604" }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" + "example": "https://github.com/api-playground/projects-test/projects/12" }, - "members_url": { + "columns_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/1002604/columns" + }, + "id": { + "type": "integer", + "example": 1002604 + }, + "node_id": { + "type": "string", + "example": "MDc6UHJvamVjdDEwMDI2MDQ=" + }, + "name": { + "description": "Name of the project", + "example": "Week One Sprint", "type": "string" }, - "repositories_url": { + "body": { + "description": "Body of the project", + "example": "This project represents the sprint of the first week in January", "type": "string", - "format": "uri" + "nullable": true }, - "parent": { + "number": { + "type": "integer", + "example": 1 + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "creator": { "nullable": true, "allOf": [ { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { + "login": { + "type": "string", + "example": "octocat" + }, "id": { - "description": "Unique identifier of the team", "type": "integer", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VGVhbTE=" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, "url": { - "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" + "example": "https://api.github.com/users/octocat" }, - "members_url": { + "html_url": { "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" + "format": "uri", + "example": "https://github.com/octocat" }, - "name": { - "description": "Name of the team", + "followers_url": { "type": "string", - "example": "Justice League" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "description": { - "description": "Description of the team", + "following_url": { "type": "string", - "nullable": true, - "example": "A great team." + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "permission": { - "description": "Permission that the team will have for its repositories", + "gists_url": { "type": "string", - "example": "admin" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "privacy": { - "description": "The level of privacy this team should have", + "starred_url": { "type": "string", - "example": "closed" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "html_url": { + "subscriptions_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" + "example": "https://api.github.com/users/octocat/subscriptions" }, - "repositories_url": { + "organizations_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" + "example": "https://api.github.com/users/octocat/orgs" }, - "slug": { + "repos_url": { "type": "string", - "example": "justice-league" + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ], "nullable": true } ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "url", - "members_url", + "number", "name", - "description", - "permission", + "body", + "state", + "url", "html_url", - "repositories_url", - "slug" + "owner_url", + "creator", + "columns_url", + "created_at", + "updated_at" ] } }, @@ -49026,18 +51080,38 @@ "default": { "value": [ { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z" } ] } @@ -49053,20 +51127,30 @@ } } }, - "403": { - "description": "Forbidden", + "422": { + "description": "Validation Failed", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error Simple", + "description": "Validation Error Simple", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } } } } @@ -49078,22 +51162,26 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } ], - "category": "teams", + "category": "projects", "subcategory": null } }, "post": { - "summary": "Create a team", - "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", + "summary": "Create an organization project", + "description": "Creates an organization project board. Returns a `404 Not Found` status if projects are disabled in the organization. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", "tags": [ - "teams" + "projects" ], - "operationId": "teams/create", + "operationId": "projects/create-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#create-a-team" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects/#create-an-organization-project" }, "parameters": [ { @@ -49113,47 +51201,11 @@ "properties": { "name": { "type": "string", - "description": "The name of the team." - }, - "description": { - "type": "string", - "description": "The description of the team." - }, - "maintainers": { - "type": "array", - "description": "List GitHub IDs for organization members who will become team maintainers.", - "items": { - "type": "string" - } - }, - "repo_names": { - "type": "array", - "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", - "items": { - "type": "string" - } - }, - "privacy": { - "type": "string", - "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", - "enum": [ - "secret", - "closed" - ] + "description": "The name of the project." }, - "permission": { + "body": { "type": "string", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", - "enum": [ - "pull", - "push", - "admin" - ], - "default": "pull" - }, - "parent_team_id": { - "type": "integer", - "description": "The ID of a team to set as the parent team." + "description": "The description of the project." } }, "required": [ @@ -49161,10 +51213,8 @@ ] }, "example": { - "name": "Justice League", - "description": "A great team", - "permission": "admin", - "privacy": "closed" + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year." } } } @@ -49175,555 +51225,271 @@ "content": { "application/json": { "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the team", - "example": 42, - "type": "integer" - }, - "node_id": { + "owner_url": { "type": "string", - "example": "MDQ6VGVhbTE=" + "format": "uri", + "example": "https://api.github.com/repos/api-playground/projects-test" }, "url": { - "description": "URL for the team", - "example": "https://api.github.com/organizations/1/team/1", "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/projects/1002604" }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "name": { - "description": "Name of the team", - "example": "Developers", - "type": "string" + "example": "https://github.com/api-playground/projects-test/projects/12" }, - "slug": { + "columns_url": { "type": "string", - "example": "justice-league" + "format": "uri", + "example": "https://api.github.com/projects/1002604/columns" }, - "description": { - "type": "string", - "example": "A great team.", - "nullable": true + "id": { + "type": "integer", + "example": 1002604 }, - "privacy": { - "description": "The level of privacy this team should have", + "node_id": { "type": "string", - "enum": [ - "closed", - "secret" - ], - "example": "closed" + "example": "MDc6UHJvamVjdDEwMDI2MDQ=" }, - "permission": { - "description": "Permission that the team will have for its repositories", - "example": "push", + "name": { + "description": "Name of the project", + "example": "Week One Sprint", "type": "string" }, - "members_url": { + "body": { + "description": "Body of the project", + "example": "This project represents the sprint of the first week in January", "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" + "nullable": true }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" + "number": { + "type": "integer", + "example": 1 }, - "parent": { + "state": { + "description": "State of the project; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "creator": { "nullable": true, "allOf": [ { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { + "login": { + "type": "string", + "example": "octocat" + }, "id": { - "description": "Unique identifier of the team", "type": "integer", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VGVhbTE=" + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, "url": { - "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" + "example": "https://api.github.com/users/octocat" }, - "members_url": { + "html_url": { "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" + "format": "uri", + "example": "https://github.com/octocat" }, - "name": { - "description": "Name of the team", + "followers_url": { "type": "string", - "example": "Justice League" + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "description": { - "description": "Description of the team", + "following_url": { "type": "string", - "nullable": true, - "example": "A great team." + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "permission": { - "description": "Permission that the team will have for its repositories", + "gists_url": { "type": "string", - "example": "admin" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "privacy": { - "description": "The level of privacy this team should have", + "starred_url": { "type": "string", - "example": "closed" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "html_url": { + "subscriptions_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" + "example": "https://api.github.com/users/octocat/subscriptions" }, - "repositories_url": { + "organizations_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" + "example": "https://api.github.com/users/octocat/orgs" }, - "slug": { + "repos_url": { "type": "string", - "example": "justice-league" + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } }, "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", "id", "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" ], "nullable": true } ] }, - "members_count": { - "type": "integer", - "example": 3 - }, - "repos_count": { - "type": "integer", - "example": 10 - }, "created_at": { "type": "string", "format": "date-time", - "example": "2017-07-14T16:53:42Z" + "example": "2011-04-10T20:09:31Z" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2017-08-17T12:37:15Z" + "example": "2014-03-03T18:58:10Z" }, - "organization": { - "title": "Organization Full", - "description": "Organization Full", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": "string", - "nullable": true - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at" + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" ] }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" } }, "required": [ "id", "node_id", - "url", - "members_url", + "number", "name", - "description", - "permission", + "body", + "state", + "url", "html_url", - "repositories_url", - "slug", + "owner_url", + "creator", + "columns_url", "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" + "updated_at" ] }, "examples": { "default": { "value": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", + "creator": { + "login": "octocat", "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - } + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z" } } } } } }, - "422": { - "description": "Validation Failed", + "401": { + "description": "Requires Authentication", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } } } } @@ -49749,544 +51515,29 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - - ], - "category": "teams", - "subcategory": null - } - } - }, - "/orgs/{org}/teams/{team_slug}": { - "get": { - "summary": "Get a team by name", - "description": "Gets a team using the team's `slug`. GitHub AE generates the `slug` from the team `name`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", - "tags": [ - "teams" - ], - "operationId": "teams/get-by-name", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#get-a-team-by-name" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "response", + "404": { + "description": "Resource Not Found", "content": { "application/json": { "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the team", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "example": "https://api.github.com/organizations/1/team/1", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "name": { - "description": "Name of the team", - "example": "Developers", - "type": "string" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "description": { - "type": "string", - "example": "A great team.", - "nullable": true - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "example": "closed" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "example": "push", + "message": { "type": "string" }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "parent": { - "nullable": true, - "allOf": [ - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } - ] - }, - "members_count": { - "type": "integer", - "example": 3 - }, - "repos_count": { - "type": "integer", - "example": 10 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-14T16:53:42Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-08-17T12:37:15Z" - }, - "organization": { - "title": "Organization Full", - "description": "Organization Full", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": "string", - "nullable": true - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "updated_at": { - "type": "string", - "format": "date-time" - } - }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at" - ] - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", + "documentation_url": { "type": "string" } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] - }, - "examples": { - "default": { - "value": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, - "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" - } - } } } } } }, - "404": { - "description": "Resource Not Found", + "410": { + "description": "Gone", "content": { "application/json": { "schema": { @@ -50304,28 +51555,64 @@ } } } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } ], - "category": "teams", + "category": "projects", "subcategory": null } - }, - "patch": { - "summary": "Update a team", - "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", + } + }, + "/orgs/{org}/public_members": { + "get": { + "summary": "List public organization members", + "description": "Members of an organization can choose to have their membership publicized or not.", "tags": [ - "teams" + "orgs" ], - "operationId": "teams/update-in-org", + "operationId": "orgs/list-public-members", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#update-a-team" + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#list-public-organization-members" }, "parameters": [ { @@ -50337,552 +51624,179 @@ } }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 30 } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the team." - }, - "description": { - "type": "string", - "description": "The description of the team." - }, - "privacy": { - "type": "string", - "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", - "enum": [ - "secret", - "closed" - ] - }, - "permission": { - "type": "string", - "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", - "enum": [ - "pull", - "push", - "admin" - ], - "default": "pull" - }, - "parent_team_id": { - "type": "integer", - "description": "The ID of a team to set as the parent team.", - "nullable": true - } - } - }, - "example": { - "name": "new team name", - "description": "new team description", - "privacy": "closed" - } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 } } - }, + ], "responses": { - "201": { + "200": { "description": "response", "content": { "application/json": { "schema": { - "title": "Full Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "example": "https://api.github.com/organizations/1/team/1", - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "name": { - "description": "Name of the team", - "example": "Developers", - "type": "string" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "description": { - "type": "string", - "example": "A great team.", - "nullable": true - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "enum": [ - "closed", - "secret" - ], - "example": "closed" - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "example": "push", - "type": "string" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "parent": { - "nullable": true, - "allOf": [ - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VGVhbTE=" - }, - "url": { - "description": "URL for the team", - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" - }, - "name": { - "description": "Name of the team", - "type": "string", - "example": "Justice League" - }, - "description": { - "description": "Description of the team", - "type": "string", - "nullable": true, - "example": "A great team." - }, - "permission": { - "description": "Permission that the team will have for its repositories", - "type": "string", - "example": "admin" - }, - "privacy": { - "description": "The level of privacy this team should have", - "type": "string", - "example": "closed" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "repositories_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" - }, - "slug": { - "type": "string", - "example": "justice-league" - }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } - ] - }, - "members_count": { - "type": "integer", - "example": 3 - }, - "repos_count": { - "type": "integer", - "example": 10 - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-14T16:53:42Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-08-17T12:37:15Z" - }, - "organization": { - "title": "Organization Full", - "description": "Organization Full", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "github" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDEyOk9yZ2FuaXphdGlvbjE=" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/repos" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/orgs/github/events" - }, - "hooks_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/hooks" - }, - "issues_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/issues" - }, - "members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/members{/member}" - }, - "public_members_url": { - "type": "string", - "example": "https://api.github.com/orgs/github/public_members{/member}" - }, - "avatar_url": { - "type": "string", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "description": { - "type": "string", - "example": "A great organization", - "nullable": true - }, - "name": { - "type": "string", - "example": "github" - }, - "company": { - "type": "string", - "example": "GitHub" - }, - "blog": { - "type": "string", - "format": "uri", - "example": "https://github.com/blog" - }, - "location": { - "type": "string", - "example": "San Francisco" - }, - "email": { - "type": "string", - "format": "email", - "example": "octocat@github.com" - }, - "twitter_username": { - "type": "string", - "example": "github", - "nullable": true - }, - "is_verified": { - "type": "boolean", - "example": true - }, - "has_organization_projects": { - "type": "boolean", - "example": true - }, - "has_repository_projects": { - "type": "boolean", - "example": true - }, - "public_repos": { - "type": "integer", - "example": 2 - }, - "public_gists": { - "type": "integer", - "example": 1 - }, - "followers": { - "type": "integer", - "example": 20 - }, - "following": { - "type": "integer", - "example": 0 - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2008-01-14T04:33:35Z" - }, - "type": { - "type": "string", - "example": "Organization" - }, - "total_private_repos": { - "type": "integer", - "example": 100 - }, - "owned_private_repos": { - "type": "integer", - "example": 100 - }, - "private_gists": { - "type": "integer", - "example": 81, - "nullable": true - }, - "disk_usage": { - "type": "integer", - "example": 10000, - "nullable": true - }, - "collaborators": { - "type": "integer", - "example": 8, - "nullable": true - }, - "billing_email": { - "type": "string", - "format": "email", - "example": "org@example.com", - "nullable": true - }, - "plan": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "space": { - "type": "integer" - }, - "private_repos": { - "type": "integer" - }, - "filled_seats": { - "type": "integer" - }, - "seats": { - "type": "integer" - } - }, - "required": [ - "name", - "space", - "private_repos" - ] - }, - "default_repository_permission": { - "type": "string", - "nullable": true - }, - "members_can_create_repositories": { - "type": "boolean", - "example": true, - "nullable": true - }, - "two_factor_requirement_enabled": { - "type": "boolean", - "example": true, - "nullable": true - }, - "members_allowed_repository_creation_type": { - "type": "string", - "example": "all" - }, - "members_can_create_public_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_private_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_internal_repositories": { - "type": "boolean", - "example": true - }, - "members_can_create_pages": { - "type": "boolean", - "example": true - }, - "updated_at": { - "type": "string", - "format": "date-time" - } + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" }, - "required": [ - "login", - "url", - "id", - "node_id", - "repos_url", - "events_url", - "hooks_url", - "issues_url", - "members_url", - "public_members_url", - "avatar_url", - "description", - "html_url", - "has_organization_projects", - "has_repository_projects", - "public_repos", - "public_gists", - "followers", - "following", - "type", - "created_at", - "updated_at" - ] + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug", - "created_at", - "updated_at", - "members_count", - "repos_count", - "organization" - ] + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } }, "examples": { "default": { - "value": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos", - "parent": null, - "members_count": 3, - "repos_count": 10, - "created_at": "2017-07-14T16:53:42Z", - "updated_at": "2017-08-17T12:37:15Z", - "organization": { - "login": "github", + "value": [ + { + "login": "octocat", "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "node_id": "MDQ6VXNlcjE=", "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "description": "A great organization", - "name": "github", - "company": "GitHub", - "blog": "https://github.com/blog", - "location": "San Francisco", - "email": "octocat@github.com", - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 2, - "public_gists": 1, - "followers": 20, - "following": 0, + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", "html_url": "https://github.com/octocat", - "created_at": "2008-01-14T04:33:35Z", - "updated_at": "2017-08-17T12:37:15Z", - "type": "Organization" + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false } - } + ] } } } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } } } }, @@ -50892,20 +51806,133 @@ "previews": [ ], - "category": "teams", - "subcategory": null + "category": "orgs", + "subcategory": "members" + } + } + }, + "/orgs/{org}/public_members/{username}": { + "get": { + "summary": "Check public organization membership for a user", + "description": "", + "tags": [ + "orgs" + ], + "operationId": "orgs/check-public-membership-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#check-public-organization-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Response if user is a public member" + }, + "404": { + "description": "Response if user is not a public member" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "orgs", + "subcategory": "members" + } + }, + "put": { + "summary": "Set public organization membership for the authenticated user", + "description": "The user can publicize their own membership. (A user cannot publicize the membership for another user.)\n\nNote that you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "tags": [ + "orgs" + ], + "operationId": "orgs/set-public-membership-for-authenticated-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#set-public-organization-membership-for-the-authenticated-user" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + + ], + "category": "orgs", + "subcategory": "members" } }, "delete": { - "summary": "Delete a team", - "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", + "summary": "Remove public organization membership for the authenticated user", + "description": "", "tags": [ - "teams" + "orgs" ], - "operationId": "teams/delete-in-org", + "operationId": "orgs/remove-public-membership-for-authenticated-user", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#delete-a-team" + "url": "https://docs.github.com/github-ae@latest/rest/reference/orgs#remove-public-organization-membership-for-the-authenticated-user" }, "parameters": [ { @@ -50917,8 +51944,7 @@ } }, { - "name": "team_slug", - "description": "team_slug parameter", + "name": "username", "in": "path", "required": true, "schema": { @@ -50933,26 +51959,26 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "previews": [ ], - "category": "teams", - "subcategory": null + "category": "orgs", + "subcategory": "members" } } }, - "/orgs/{org}/teams/{team_slug}/discussions": { + "/orgs/{org}/repos": { "get": { - "summary": "List discussions", - "description": "List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.", + "summary": "List organization repositories", + "description": "Lists repositories for the specified organization.", "tags": [ - "teams" + "repos" ], - "operationId": "teams/list-discussions-in-org", + "operationId": "repos/list-for-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#list-discussions" + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#list-organization-repositories" }, "parameters": [ { @@ -50964,17 +51990,42 @@ } }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, + "name": "type", + "description": "Specifies the types of repositories you want returned. Can be one of `all`, `public`, `private`, `forks`, `sources`, `member`, `internal`. Note: For GitHub AE, can be one of `all`, `private`, `forks`, `sources`, `member`, `internal`. Default: `all`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `type` can also be `internal`.", + "in": "query", + "required": false, "schema": { - "type": "string" + "type": "string", + "enum": [ + "all", + "public", + "private", + "forks", + "sources", + "member", + "internal" + ] + } + }, + { + "name": "sort", + "description": "Can be one of `created`, `updated`, `pushed`, `full_name`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "created", + "updated", + "pushed", + "full_name" + ], + "default": "created" } }, { "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", + "description": "Can be one of `asc` or `desc`. Default: when using `full_name`: `asc`, otherwise `desc`", "in": "query", "required": false, "schema": { @@ -50982,8 +52033,7 @@ "enum": [ "asc", "desc" - ], - "default": "desc" + ] } }, { @@ -51013,11 +52063,28 @@ "schema": { "type": "array", "items": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { - "author": { + "id": { + "type": "integer", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "type": "object", "nullable": true, "allOf": [ { @@ -51134,150 +52201,1351 @@ } ] }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string" }, - "body_html": { + "issue_comment_url": { "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { "type": "string" }, - "comments_count": { - "type": "integer", - "example": 0 + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, - "comments_url": { + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, - "created_at": { + "subscription_url": { "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, - "last_edited_at": { + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { "type": "string", - "format": "date-time", "nullable": true }, - "html_url": { + "hooks_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, - "node_id": { + "svn_url": { + "type": "string" + }, + "homepage": { "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" + "nullable": true }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { "type": "integer" }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { "type": "boolean" }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization administrators.", - "example": true, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { "type": "boolean" }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" + "has_projects": { + "type": "boolean" }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { "type": "string" }, - "updated_at": { + "pushed_at": { "type": "string", "format": "date-time", - "example": "2018-01-25T18:56:31Z" + "example": "2011-01-26T19:06:43Z", + "nullable": true }, - "url": { + "created_at": { "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true }, - "reactions": { - "title": "Reaction Rollup", + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" + "admin": { + "type": "boolean" }, - "total_count": { - "type": "integer" + "push": { + "type": "boolean" }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" + "pull": { + "type": "boolean" + } + } + }, + "template_repository": { + "nullable": true, + "type": "object", + "allOf": [ + { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" }, - "heart": { - "type": "integer" + "name": { + "type": "string" }, - "hooray": { - "type": "integer" + "spdx_id": { + "type": "string" }, - "eyes": { - "type": "integer" + "url": { + "type": "string" }, - "rocket": { - "type": "integer" + "node_id": { + "type": "string" } }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", "comments_url", - "created_at", - "last_edited_at", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", - "pinned", - "private", + "id", "node_id", - "number", - "team_url", - "title", - "updated_at", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", "url" ] } @@ -51286,7 +53554,11 @@ "default": { "value": [ { - "author": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -51306,33 +53578,203 @@ "type": "User", "site_admin": false }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 0, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 } } ] @@ -51356,24 +53798,29 @@ "previews": [ { "required": false, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." + "name": "nebula", + "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" + }, + { + "required": false, + "name": "baptiste", + "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" } ], - "category": "teams", - "subcategory": "discussions" + "category": "repos", + "subcategory": null } }, "post": { - "summary": "Create a discussion", - "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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 abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", + "summary": "Create an organization repository", + "description": "Creates a new repository in the specified organization. The authenticated user must be a member of the organization.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ - "teams" + "repos" ], - "operationId": "teams/create-discussion-in-org", + "operationId": "repos/create-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-discussion" + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#create-an-organization-repository" }, "parameters": [ { @@ -51383,15 +53830,6 @@ "schema": { "type": "string" } - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "requestBody": { @@ -51400,28 +53838,103 @@ "schema": { "type": "object", "properties": { - "title": { + "name": { "type": "string", - "description": "The discussion post's title." + "description": "The name of the repository." }, - "body": { + "description": { "type": "string", - "description": "The discussion post's body text." + "description": "A short description of the repository." + }, + "homepage": { + "type": "string", + "description": "A URL with more information about the repository." }, "private": { "type": "boolean", - "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", + "description": "Whether the repository is private.", + "default": false + }, + "visibility": { + "type": "string", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. Note: For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise. For more information, see \"[Creating an internal repository](https://help.github.com/en/github/creating-cloning-and-archiving-repositories/about-repository-visibility#about-internal-repositories)\" in the GitHub Help documentation. \nThe `visibility` parameter overrides the `private` parameter when you use both parameters with the `nebula-preview` preview header.", + "enum": [ + "public", + "private", + "visibility", + "internal" + ] + }, + "has_issues": { + "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "default": true + }, + "has_projects": { + "type": "boolean", + "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", + "default": true + }, + "has_wiki": { + "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "default": true + }, + "is_template": { + "type": "boolean", + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "default": false + }, + "team_id": { + "type": "integer", + "description": "The id of the team that will be granted access to this repository. This is only valid when creating a repository in an organization." + }, + "auto_init": { + "type": "boolean", + "description": "Pass `true` to create an initial commit with empty README.", + "default": false + }, + "gitignore_template": { + "type": "string", + "description": "Desired language or platform [.gitignore template](https://github.com/github/gitignore) to apply. Use the name of the template without the extension. For example, \"Haskell\"." + }, + "license_template": { + "type": "string", + "description": "Choose an [open source license template](https://choosealicense.com/) that best suits your needs, and then use the [license keyword](https://help.github.com/articles/licensing-a-repository/#searching-github-by-license-type) as the `license_template` string. For example, \"mit\" or \"mpl-2.0\"." + }, + "allow_squash_merge": { + "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "default": true + }, + "allow_merge_commit": { + "type": "boolean", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "default": true + }, + "allow_rebase_merge": { + "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "default": true + }, + "delete_branch_on_merge": { + "type": "boolean", + "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", "default": false } }, "required": [ - "title", - "body" + "name" ] }, "example": { - "title": "Our first team post", - "body": "Hi! This is an area for us to collaborate as a team." + "name": "Hello-World", + "description": "This is your first repository", + "homepage": "https://github.com", + "private": false, + "has_issues": true, + "has_projects": true, + "has_wiki": true } } } @@ -51432,398 +53945,103 @@ "content": { "application/json": { "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "title": "Repository", + "description": "A git repository", "type": "object", "properties": { - "author": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { "nullable": true, "allOf": [ { - "title": "Simple User", - "description": "Simple User", + "title": "License Simple", + "description": "License Simple", "type": "object", "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { + "key": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "example": "mit" }, - "gravatar_id": { + "name": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MIT License" }, "url": { "type": "string", + "nullable": true, "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "https://api.github.com/licenses/mit" }, - "received_events_url": { + "spdx_id": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "nullable": true, + "example": "MIT" }, - "type": { + "node_id": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "example": "MDc6TGljZW5zZW1pdA==" }, - "starred_at": { + "html_url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "format": "uri" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true + "key", + "name", + "url", + "spdx_id", + "node_id" + ] } ] }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { - "type": "integer", - "example": 0 - }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, + "forks": { "type": "integer" }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization administrators.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" - }, - "reactions": { - "title": "Reaction Rollup", + "permissions": { "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" + "admin": { + "type": "boolean" }, - "heart": { - "type": "integer" + "pull": { + "type": "boolean" }, - "hooray": { - "type": "integer" + "triage": { + "type": "boolean" }, - "eyes": { - "type": "integer" + "push": { + "type": "boolean" }, - "rocket": { - "type": "integer" + "maintain": { + "type": "boolean" } }, "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "admin", + "pull", + "push" ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", - "node_id", - "number", - "team_url", - "title", - "updated_at", - "url" - ] - }, - "examples": { - "default": { - "value": { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 0, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." - } - ], - "category": "teams", - "subcategory": "discussions" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { - "get": { - "summary": "Get a discussion", - "description": "Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.", - "tags": [ - "teams" - ], - "operationId": "teams/get-discussion-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#get-a-discussion" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { + }, + "owner": { "nullable": true, "allOf": [ { @@ -51940,563 +54158,762 @@ } ] }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" }, - "body_html": { + "html_url": { "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true }, - "comments_count": { - "type": "integer", - "example": 0 + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "created_at": { + "deployments_url": { "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "last_edited_at": { + "downloads_url": { "type": "string", - "format": "date-time", - "nullable": true + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, - "html_url": { + "events_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - "node_id": { + "forks_url": { "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization administrators.", - "example": true, - "type": "boolean" + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, - "team_url": { + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, - "updated_at": { + "milestones_url": { "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, - "url": { + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { "type": "integer" }, - "heart": { - "type": "integer" + "node_id": { + "type": "string" }, - "hooray": { - "type": "integer" + "name": { + "type": "string" }, - "eyes": { - "type": "integer" + "full_name": { + "type": "string" }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", - "comments_url", - "created_at", - "last_edited_at", - "html_url", - "pinned", - "private", - "node_id", - "number", - "team_url", - "title", - "updated_at", - "url" - ] - }, - "examples": { - "default": { - "value": { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 0, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": null, - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, - "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Our first team post", - "updated_at": "2018-01-25T18:56:31Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." - } - ], - "category": "teams", - "subcategory": "discussions" - } - }, - "patch": { - "summary": "Update a discussion", - "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.", - "tags": [ - "teams" - ], - "operationId": "teams/update-discussion-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#update-a-discussion" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "title": { - "type": "string", - "description": "The discussion post's title." - }, - "body": { - "type": "string", - "description": "The discussion post's body text." - } - } - }, - "example": { - "title": "Welcome to our first team post" - } - } - } - }, - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "Team Discussion", - "description": "A team discussion is a persistent record of a free-form conversation within a team.", - "type": "object", - "properties": { - "author": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", + "owner": { "type": "object", "properties": { "login": { - "type": "string", - "example": "octocat" + "type": "string" }, "id": { - "type": "integer", - "example": 1 + "type": "integer" }, "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" + "type": "string" }, "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "type": "string" }, "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "type": "string" }, "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "type": "string" }, "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "type": "string" }, "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "type": "string" }, "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "type": "string" }, "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "type": "string" }, "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "type": "string" }, "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "type": "string" }, "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "type": "string" }, "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "type": "string" }, "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "type": "string" }, "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "type": "string" }, "type": { - "type": "string", - "example": "User" + "type": "string" }, "site_admin": { "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "body": { - "description": "The main text of the discussion.", - "example": "Please suggest improvements to our workflow in comments.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Hi! This is an area for us to collaborate as a team

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "comments_count": { - "type": "integer", - "example": 0 - }, - "comments_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" - }, - "node_id": { - "type": "string", - "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" - }, - "number": { - "description": "The unique sequence number of a team discussion.", - "example": 42, - "type": "integer" - }, - "pinned": { - "description": "Whether or not this discussion should be pinned for easy retrieval.", - "example": true, - "type": "boolean" - }, - "private": { - "description": "Whether or not this discussion should be restricted to team members and organization administrators.", - "example": true, - "type": "boolean" - }, - "team_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027" - }, - "title": { - "description": "The title of the discussion.", - "example": "How can we improve our workflow?", - "type": "string" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-25T18:56:31Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, "url": { - "type": "string", - "format": "uri" + "type": "string" }, - "total_count": { - "type": "integer" + "archive_url": { + "type": "string" }, - "+1": { - "type": "integer" + "assignees_url": { + "type": "string" }, - "-1": { + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { "type": "integer" }, - "laugh": { + "stargazers_count": { "type": "integer" }, - "confused": { + "watchers_count": { "type": "integer" }, - "heart": { + "size": { "type": "integer" }, - "hooray": { + "default_branch": { + "type": "string" + }, + "open_issues_count": { "type": "integer" }, - "eyes": { + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { "type": "integer" }, - "rocket": { + "network_count": { "type": "integer" } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "comments_count", + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", "comments_url", - "created_at", - "last_edited_at", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", "html_url", - "pinned", - "private", + "id", "node_id", - "number", - "team_url", - "title", - "updated_at", - "url" + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" ] }, "examples": { "default": { "value": { - "author": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -52516,120 +54933,237 @@ "type": "User", "site_admin": false }, - "body": "Hi! This is an area for us to collaborate as a team.", - "body_html": "

Hi! This is an area for us to collaborate as a team

", - "body_version": "0d495416a700fb06133c612575d92bfb", - "comments_count": 1, - "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", - "created_at": "2018-01-25T18:56:31Z", - "last_edited_at": "2018-01-26T18:22:20Z", - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", - "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", - "number": 1, - "pinned": false, "private": false, - "team_url": "https://api.github.com/teams/2343027", - "title": "Welcome to our first team post", - "updated_at": "2018-01-26T18:22:20Z", - "url": "https://api.github.com/teams/2343027/discussions/1", - "reactions": { - "url": "https://api.github.com/teams/2343027/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." - } - ], - "category": "teams", - "subcategory": "discussions" - } - }, - "delete": { - "summary": "Delete a discussion", - "description": "Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.", - "tags": [ - "teams" - ], - "operationId": "teams/delete-discussion-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#delete-a-discussion" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Empty response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - - ], - "category": "teams", - "subcategory": "discussions" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { - "get": { - "summary": "List discussion comments", - "description": "List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", - "tags": [ + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": null, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + } + } + } + } + }, + "headers": { + "Location": { + "example": "https://api.github.com/repos/octocat/Hello-World", + "schema": { + "type": "string" + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "nebula", + "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" + }, + { + "required": false, + "name": "baptiste", + "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" + } + ], + "category": "repos", + "subcategory": null + } + } + }, + "/orgs/{org}/teams": { + "get": { + "summary": "List teams", + "description": "Lists all teams in an organization that are visible to the authenticated user.", + "tags": [ "teams" ], - "operationId": "teams/list-discussion-comments-in-org", + "operationId": "teams/list", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#list-discussion-comments" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#list-teams" }, "parameters": [ { @@ -52640,37 +55174,6 @@ "type": "string" } }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "direction", - "description": "One of `asc` (ascending) or `desc` (descending).", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "default": "desc" - } - }, { "name": "per_page", "description": "Results per page (max 100).", @@ -52698,243 +55201,144 @@ "schema": { "type": "array", "items": { - "title": "Team Discussion Comment", - "description": "A reply to a discussion within a team.", + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "author": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { "nullable": true, "allOf": [ { - "title": "Simple User", - "description": "Simple User", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "login": { - "type": "string", - "example": "octocat" - }, "id": { + "description": "Unique identifier of the team", "type": "integer", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MDQ6VGVhbTE=" }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "https://api.github.com/organizations/1/team/1" }, - "following_url": { + "members_url": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, - "gists_url": { + "name": { + "description": "Name of the team", "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "Justice League" }, - "starred_url": { + "description": { + "description": "Description of the team", "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "nullable": true, + "example": "A great team." }, - "subscriptions_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "admin" }, - "organizations_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "closed" }, - "repos_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "https://github.com/orgs/rails/teams/core" }, - "received_events_url": { + "repositories_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "example": "https://api.github.com/organizations/1/team/1/repos" }, - "type": { + "slug": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "example": "justice-league" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" ], "nullable": true } ] - }, - "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Do you like apples?

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-15T23:53:58Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" - }, - "node_id": { - "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" - }, - "number": { - "description": "The unique sequence number of a team discussion comment.", - "example": 42, - "type": "integer" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-15T23:53:58Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "total_count": { - "type": "integer" - }, - "+1": { - "type": "integer" - }, - "-1": { - "type": "integer" - }, - "laugh": { - "type": "integer" - }, - "confused": { - "type": "integer" - }, - "heart": { - "type": "integer" - }, - "hooray": { - "type": "integer" - }, - "eyes": { - "type": "integer" - }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "created_at", - "last_edited_at", - "discussion_url", - "html_url", + "id", "node_id", - "number", - "updated_at", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" ] } }, @@ -52942,49 +55346,18 @@ "default": { "value": [ { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Do you like apples?", - "body_html": "

Do you like apples?

", - "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", - "created_at": "2018-01-15T23:53:58Z", - "last_edited_at": null, - "discussion_url": "https://api.github.com/teams/2403582/discussions/1", - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", - "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", - "number": 1, - "updated_at": "2018-01-15T23:53:58Z", - "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", - "reactions": { - "url": "https://api.github.com/teams/2403582/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null } ] } @@ -52999,32 +55372,48 @@ } } } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": false, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." - } + ], "category": "teams", - "subcategory": "discussion-comments" + "subcategory": null } }, "post": { - "summary": "Create a discussion comment", - "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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 abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", + "summary": "Create a team", + "description": "To create a team, the authenticated user must be a member or owner of `{org}`. By default, organization members can create teams. Organization owners can limit team creation to organization owners. For more information, see \"[Setting team creation permissions](https://help.github.com/en/articles/setting-team-creation-permissions-in-your-organization).\"\n\nWhen you create a new team, you automatically become a team maintainer without explicitly adding yourself to the optional array of `maintainers`. For more information, see \"[About teams](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/about-teams)\".", "tags": [ "teams" ], - "operationId": "teams/create-discussion-comment-in-org", + "operationId": "teams/create", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-discussion-comment" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#create-a-team" }, "parameters": [ { @@ -53034,23 +55423,6 @@ "schema": { "type": "string" } - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -53059,17 +55431,60 @@ "schema": { "type": "object", "properties": { - "body": { + "name": { "type": "string", - "description": "The discussion comment's body text." + "description": "The name of the team." + }, + "description": { + "type": "string", + "description": "The description of the team." + }, + "maintainers": { + "type": "array", + "description": "List GitHub IDs for organization members who will become team maintainers.", + "items": { + "type": "string" + } + }, + "repo_names": { + "type": "array", + "description": "The full name (e.g., \"organization-name/repository-name\") of repositories to add the team to.", + "items": { + "type": "string" + } + }, + "privacy": { + "type": "string", + "description": "The level of privacy this team should have. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \nDefault: `secret` \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization. \nDefault for child team: `closed`", + "enum": [ + "secret", + "closed" + ] + }, + "permission": { + "type": "string", + "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", + "enum": [ + "pull", + "push", + "admin" + ], + "default": "pull" + }, + "parent_team_id": { + "type": "integer", + "description": "The ID of a team to set as the parent team." } }, "required": [ - "body" + "name" ] }, "example": { - "body": "Do you like apples?" + "name": "Justice League", + "description": "A great team", + "permission": "admin", + "privacy": "closed" } } } @@ -53080,683 +55495,604 @@ "content": { "application/json": { "schema": { - "title": "Team Discussion Comment", - "description": "A reply to a discussion within a team.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "author": { + "id": { + "description": "Unique identifier of the team", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "example": "https://api.github.com/organizations/1/team/1", + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "name": { + "description": "Name of the team", + "example": "Developers", + "type": "string" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "description": { + "type": "string", + "example": "A great team.", + "nullable": true + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "example": "closed" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "example": "push", + "type": "string" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "parent": { "nullable": true, "allOf": [ { - "title": "Simple User", - "description": "Simple User", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "login": { - "type": "string", - "example": "octocat" - }, "id": { + "description": "Unique identifier of the team", "type": "integer", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MDQ6VGVhbTE=" }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "https://api.github.com/organizations/1/team/1" }, - "following_url": { + "members_url": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, - "gists_url": { + "name": { + "description": "Name of the team", "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "Justice League" }, - "starred_url": { + "description": { + "description": "Description of the team", "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "nullable": true, + "example": "A great team." }, - "subscriptions_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "admin" }, - "organizations_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "closed" }, - "repos_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "https://github.com/orgs/rails/teams/core" }, - "received_events_url": { + "repositories_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "example": "https://api.github.com/organizations/1/team/1/repos" }, - "type": { + "slug": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "example": "justice-league" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" ], "nullable": true } ] }, - "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Do you like apples?

" + "members_count": { + "type": "integer", + "example": 3 }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" + "repos_count": { + "type": "integer", + "example": 10 }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" - }, - "node_id": { - "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" - }, - "number": { - "description": "The unique sequence number of a team discussion comment.", - "example": 42, - "type": "integer" + "example": "2017-07-14T16:53:42Z" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "2017-08-17T12:37:15Z" }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Organization Full", + "description": "Organization Full", "type": "object", "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/orgs/github" }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "eyes": { - "type": "integer" + "description": { + "type": "string", + "example": "A great organization", + "nullable": true }, - "rocket": { - "type": "integer" - } - }, - "required": [ - "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" - ] - } - }, - "required": [ - "author", - "body", - "body_html", - "body_version", - "created_at", - "last_edited_at", - "discussion_url", - "html_url", - "node_id", - "number", - "updated_at", - "url" - ] - }, - "examples": { - "default": { - "value": { - "author": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Do you like apples?", - "body_html": "

Do you like apples?

", - "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", - "created_at": "2018-01-15T23:53:58Z", - "last_edited_at": null, - "discussion_url": "https://api.github.com/teams/2403582/discussions/1", - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", - "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", - "number": 1, - "updated_at": "2018-01-15T23:53:58Z", - "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", - "reactions": { - "url": "https://api.github.com/teams/2403582/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 - } - } - } - } - } - } - } - }, - "x-github": { - "triggersNotification": true, - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": false, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." - } - ], - "category": "teams", - "subcategory": "discussion-comments" - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { - "get": { - "summary": "Get a discussion comment", - "description": "Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.", - "tags": [ - "teams" - ], - "operationId": "teams/get-discussion-comment-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#get-a-discussion-comment" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "comment_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "Team Discussion Comment", - "description": "A reply to a discussion within a team.", - "type": "object", - "properties": { - "author": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", + "name": { + "type": "string", + "example": "github" + }, + "company": { + "type": "string", + "example": "GitHub" + }, + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" + }, + "location": { + "type": "string", + "example": "San Francisco" + }, + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" + }, + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true + }, + "is_verified": { + "type": "boolean", + "example": true + }, + "has_organization_projects": { + "type": "boolean", + "example": true + }, + "has_repository_projects": { + "type": "boolean", + "example": true + }, + "public_repos": { + "type": "integer", + "example": 2 + }, + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "plan": { "type": "object", "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "name": { + "type": "string" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "space": { + "type": "integer" }, - "type": { - "type": "string", - "example": "User" + "private_repos": { + "type": "integer" }, - "site_admin": { - "type": "boolean" + "filled_seats": { + "type": "integer" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "seats": { + "type": "integer" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Do you like apples?

" - }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-15T23:53:58Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" - }, - "node_id": { - "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" - }, - "number": { - "description": "The unique sequence number of a team discussion comment.", - "example": 42, - "type": "integer" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2018-01-15T23:53:58Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" - }, - "reactions": { - "title": "Reaction Rollup", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" + "name", + "space", + "private_repos" + ] }, - "total_count": { - "type": "integer" + "default_repository_permission": { + "type": "string", + "nullable": true }, - "+1": { - "type": "integer" + "members_can_create_repositories": { + "type": "boolean", + "example": true, + "nullable": true }, - "-1": { - "type": "integer" + "two_factor_requirement_enabled": { + "type": "boolean", + "example": true, + "nullable": true }, - "laugh": { - "type": "integer" + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" }, - "confused": { - "type": "integer" + "members_can_create_public_repositories": { + "type": "boolean", + "example": true }, - "heart": { - "type": "integer" + "members_can_create_private_repositories": { + "type": "boolean", + "example": true }, - "hooray": { - "type": "integer" + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true }, - "eyes": { - "type": "integer" + "members_can_create_pages": { + "type": "boolean", + "example": true }, - "rocket": { - "type": "integer" + "updated_at": { + "type": "string", + "format": "date-time" } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at" ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "created_at", - "last_edited_at", - "discussion_url", - "html_url", + "id", "node_id", - "number", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "created_at", "updated_at", - "url" + "members_count", + "repos_count", + "organization" ] }, "examples": { "default": { "value": { - "author": { - "login": "octocat", + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Do you like apples?", - "body_html": "

Do you like apples?

", - "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", - "created_at": "2018-01-15T23:53:58Z", - "last_edited_at": null, - "discussion_url": "https://api.github.com/teams/2403582/discussions/1", - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", - "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", - "number": 1, - "updated_at": "2018-01-15T23:53:58Z", - "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", - "reactions": { - "url": "https://api.github.com/teams/2403582/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + } + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } } } } } } } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": false, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." - } + ], "category": "teams", - "subcategory": "discussion-comments" + "subcategory": null } - }, - "patch": { - "summary": "Update a discussion comment", - "description": "Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.", + } + }, + "/orgs/{org}/teams/{team_slug}": { + "get": { + "summary": "Get a team by name", + "description": "Gets a team using the team's `slug`. GitHub AE generates the `slug` from the team `name`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], - "operationId": "teams/update-discussion-comment-in-org", + "operationId": "teams/get-by-name", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#update-a-discussion-comment" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#get-a-team-by-name" }, "parameters": [ { @@ -53775,367 +56111,541 @@ "schema": { "type": "string" } - }, - { - "name": "discussion_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "comment_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "body": { - "type": "string", - "description": "The discussion comment's body text." - } - }, - "required": [ - "body" - ] - }, - "example": { - "body": "Do you like pineapples?" - } - } - } - }, "responses": { "200": { "description": "response", "content": { "application/json": { "schema": { - "title": "Team Discussion Comment", - "description": "A reply to a discussion within a team.", + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "author": { + "id": { + "description": "Unique identifier of the team", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "example": "https://api.github.com/organizations/1/team/1", + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "name": { + "description": "Name of the team", + "example": "Developers", + "type": "string" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "description": { + "type": "string", + "example": "A great team.", + "nullable": true + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "example": "closed" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "example": "push", + "type": "string" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "parent": { "nullable": true, "allOf": [ { - "title": "Simple User", - "description": "Simple User", + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", "type": "object", "properties": { - "login": { - "type": "string", - "example": "octocat" - }, "id": { + "description": "Unique identifier of the team", "type": "integer", "example": 1 }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "MDQ6VGVhbTE=" }, "url": { + "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "https://api.github.com/organizations/1/team/1" }, - "following_url": { + "members_url": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "example": "https://api.github.com/organizations/1/team/1/members{/member}" }, - "gists_url": { + "name": { + "description": "Name of the team", "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "example": "Justice League" }, - "starred_url": { + "description": { + "description": "Description of the team", "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "nullable": true, + "example": "A great team." }, - "subscriptions_url": { + "permission": { + "description": "Permission that the team will have for its repositories", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "admin" }, - "organizations_url": { + "privacy": { + "description": "The level of privacy this team should have", "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "closed" }, - "repos_url": { + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "example": "https://github.com/orgs/rails/teams/core" }, - "received_events_url": { + "repositories_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "example": "https://api.github.com/organizations/1/team/1/repos" }, - "type": { + "slug": { "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "example": "justice-league" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" ], "nullable": true } ] }, - "body": { - "description": "The main text of the comment.", - "example": "I agree with this suggestion.", - "type": "string" - }, - "body_html": { - "type": "string", - "example": "

Do you like apples?

" + "members_count": { + "type": "integer", + "example": 3 }, - "body_version": { - "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", - "example": "0307116bbf7ced493b8d8a346c650b71", - "type": "string" + "repos_count": { + "type": "integer", + "example": 10 }, "created_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" - }, - "last_edited_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "discussion_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" - }, - "node_id": { - "type": "string", - "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" - }, - "number": { - "description": "The unique sequence number of a team discussion comment.", - "example": 42, - "type": "integer" + "example": "2017-07-14T16:53:42Z" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2018-01-15T23:53:58Z" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + "example": "2017-08-17T12:37:15Z" }, - "reactions": { - "title": "Reaction Rollup", + "organization": { + "title": "Organization Full", + "description": "Organization Full", "type": "object", "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, "url": { "type": "string", - "format": "uri" + "format": "uri", + "example": "https://api.github.com/orgs/github" }, - "total_count": { - "type": "integer" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" }, - "+1": { - "type": "integer" + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" }, - "-1": { - "type": "integer" + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" }, - "laugh": { - "type": "integer" + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" }, - "confused": { - "type": "integer" + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" }, - "heart": { - "type": "integer" + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" }, - "hooray": { - "type": "integer" + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "eyes": { - "type": "integer" + "description": { + "type": "string", + "example": "A great organization", + "nullable": true }, - "rocket": { - "type": "integer" - } + "name": { + "type": "string", + "example": "github" + }, + "company": { + "type": "string", + "example": "GitHub" + }, + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" + }, + "location": { + "type": "string", + "example": "San Francisco" + }, + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" + }, + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true + }, + "is_verified": { + "type": "boolean", + "example": true + }, + "has_organization_projects": { + "type": "boolean", + "example": true + }, + "has_repository_projects": { + "type": "boolean", + "example": true + }, + "public_repos": { + "type": "integer", + "example": 2 + }, + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": "string", + "nullable": true + }, + "members_can_create_repositories": { + "type": "boolean", + "example": true, + "nullable": true + }, + "two_factor_requirement_enabled": { + "type": "boolean", + "example": true, + "nullable": true + }, + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "updated_at": { + "type": "string", + "format": "date-time" + } }, "required": [ + "login", "url", - "total_count", - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "eyes", - "rocket" + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at" ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" } }, "required": [ - "author", - "body", - "body_html", - "body_version", - "created_at", - "last_edited_at", - "discussion_url", - "html_url", + "id", "node_id", - "number", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "created_at", "updated_at", - "url" + "members_count", + "repos_count", + "organization" ] }, "examples": { "default": { "value": { - "author": { - "login": "octocat", + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", "id": 1, - "node_id": "MDQ6VXNlcjE=", + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "body": "Do you like pineapples?", - "body_html": "

Do you like pineapples?

", - "body_version": "e6907b24d9c93cc0c5024a7af5888116", - "created_at": "2018-01-15T23:53:58Z", - "last_edited_at": "2018-01-26T18:22:20Z", - "discussion_url": "https://api.github.com/teams/2403582/discussions/1", - "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", - "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", - "number": 1, - "updated_at": "2018-01-26T18:22:20Z", - "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", - "reactions": { - "url": "https://api.github.com/teams/2403582/discussions/1/reactions", - "total_count": 5, - "+1": 3, - "-1": 1, - "laugh": 0, - "confused": 0, - "heart": 1, - "hooray": 0, - "eyes": 1, - "rocket": 1 + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" } } } } } } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": false, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." - } + ], "category": "teams", - "subcategory": "discussion-comments" + "subcategory": null } }, - "delete": { - "summary": "Delete a discussion comment", - "description": "Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.", + "patch": { + "summary": "Update a team", + "description": "To edit a team, the authenticated user must either be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}`.", "tags": [ "teams" ], - "operationId": "teams/delete-discussion-comment-in-org", + "operationId": "teams/update-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#delete-a-discussion-comment" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#update-a-team" }, "parameters": [ { @@ -54154,21 +56664,585 @@ "schema": { "type": "string" } - }, + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the team." + }, + "description": { + "type": "string", + "description": "The description of the team." + }, + "privacy": { + "type": "string", + "description": "The level of privacy this team should have. Editing teams without specifying this parameter leaves `privacy` intact. When a team is nested, the `privacy` for parent teams cannot be `secret`. The options are: \n**For a non-nested team:** \n\\* `secret` - only visible to organization owners and members of this team. \n\\* `closed` - visible to all members of this organization. \n**For a parent or child team:** \n\\* `closed` - visible to all members of this organization.", + "enum": [ + "secret", + "closed" + ] + }, + "permission": { + "type": "string", + "description": "**Deprecated**. The permission that new repositories will be added to the team with when none is specified. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer newly-added repositories. \n\\* `push` - team members can pull and push, but not administer newly-added repositories. \n\\* `admin` - team members can pull, push and administer newly-added repositories.", + "enum": [ + "pull", + "push", + "admin" + ], + "default": "pull" + }, + "parent_team_id": { + "type": "integer", + "description": "The ID of a team to set as the parent team.", + "nullable": true + } + } + }, + "example": { + "name": "new team name", + "description": "new team description", + "privacy": "closed" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Full Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "example": "https://api.github.com/organizations/1/team/1", + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "name": { + "description": "Name of the team", + "example": "Developers", + "type": "string" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "description": { + "type": "string", + "example": "A great team.", + "nullable": true + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "enum": [ + "closed", + "secret" + ], + "example": "closed" + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "example": "push", + "type": "string" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "parent": { + "nullable": true, + "allOf": [ + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + ] + }, + "members_count": { + "type": "integer", + "example": 3 + }, + "repos_count": { + "type": "integer", + "example": 10 + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-14T16:53:42Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-08-17T12:37:15Z" + }, + "organization": { + "title": "Organization Full", + "description": "Organization Full", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "github" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDEyOk9yZ2FuaXphdGlvbjE=" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/repos" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/orgs/github/events" + }, + "hooks_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/hooks" + }, + "issues_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/issues" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/members{/member}" + }, + "public_members_url": { + "type": "string", + "example": "https://api.github.com/orgs/github/public_members{/member}" + }, + "avatar_url": { + "type": "string", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "description": { + "type": "string", + "example": "A great organization", + "nullable": true + }, + "name": { + "type": "string", + "example": "github" + }, + "company": { + "type": "string", + "example": "GitHub" + }, + "blog": { + "type": "string", + "format": "uri", + "example": "https://github.com/blog" + }, + "location": { + "type": "string", + "example": "San Francisco" + }, + "email": { + "type": "string", + "format": "email", + "example": "octocat@github.com" + }, + "twitter_username": { + "type": "string", + "example": "github", + "nullable": true + }, + "is_verified": { + "type": "boolean", + "example": true + }, + "has_organization_projects": { + "type": "boolean", + "example": true + }, + "has_repository_projects": { + "type": "boolean", + "example": true + }, + "public_repos": { + "type": "integer", + "example": 2 + }, + "public_gists": { + "type": "integer", + "example": 1 + }, + "followers": { + "type": "integer", + "example": 20 + }, + "following": { + "type": "integer", + "example": 0 + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2008-01-14T04:33:35Z" + }, + "type": { + "type": "string", + "example": "Organization" + }, + "total_private_repos": { + "type": "integer", + "example": 100 + }, + "owned_private_repos": { + "type": "integer", + "example": 100 + }, + "private_gists": { + "type": "integer", + "example": 81, + "nullable": true + }, + "disk_usage": { + "type": "integer", + "example": 10000, + "nullable": true + }, + "collaborators": { + "type": "integer", + "example": 8, + "nullable": true + }, + "billing_email": { + "type": "string", + "format": "email", + "example": "org@example.com", + "nullable": true + }, + "plan": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "space": { + "type": "integer" + }, + "private_repos": { + "type": "integer" + }, + "filled_seats": { + "type": "integer" + }, + "seats": { + "type": "integer" + } + }, + "required": [ + "name", + "space", + "private_repos" + ] + }, + "default_repository_permission": { + "type": "string", + "nullable": true + }, + "members_can_create_repositories": { + "type": "boolean", + "example": true, + "nullable": true + }, + "two_factor_requirement_enabled": { + "type": "boolean", + "example": true, + "nullable": true + }, + "members_allowed_repository_creation_type": { + "type": "string", + "example": "all" + }, + "members_can_create_public_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_private_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_internal_repositories": { + "type": "boolean", + "example": true + }, + "members_can_create_pages": { + "type": "boolean", + "example": true + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "login", + "url", + "id", + "node_id", + "repos_url", + "events_url", + "hooks_url", + "issues_url", + "members_url", + "public_members_url", + "avatar_url", + "description", + "html_url", + "has_organization_projects", + "has_repository_projects", + "public_repos", + "public_gists", + "followers", + "following", + "type", + "created_at", + "updated_at" + ] + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug", + "created_at", + "updated_at", + "members_count", + "repos_count", + "organization" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos", + "parent": null, + "members_count": 3, + "repos_count": 10, + "created_at": "2017-07-14T16:53:42Z", + "updated_at": "2017-08-17T12:37:15Z", + "organization": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "hooks_url": "https://api.github.com/orgs/github/hooks", + "issues_url": "https://api.github.com/orgs/github/issues", + "members_url": "https://api.github.com/orgs/github/members{/member}", + "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "description": "A great organization", + "name": "github", + "company": "GitHub", + "blog": "https://github.com/blog", + "location": "San Francisco", + "email": "octocat@github.com", + "is_verified": true, + "has_organization_projects": true, + "has_repository_projects": true, + "public_repos": 2, + "public_gists": 1, + "followers": 20, + "following": 0, + "html_url": "https://github.com/octocat", + "created_at": "2008-01-14T04:33:35Z", + "updated_at": "2017-08-17T12:37:15Z", + "type": "Organization" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "teams", + "subcategory": null + } + }, + "delete": { + "summary": "Delete a team", + "description": "To delete a team, the authenticated user must be an organization owner or team maintainer.\n\nIf you are an organization owner, deleting a parent team will delete all of its child teams as well.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}`.", + "tags": [ + "teams" + ], + "operationId": "teams/delete-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#delete-a-team" + }, + "parameters": [ { - "name": "discussion_number", + "name": "org", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } }, { - "name": "comment_number", + "name": "team_slug", + "description": "team_slug parameter", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } } ], @@ -54184,21 +57258,21 @@ ], "category": "teams", - "subcategory": "discussion-comments" + "subcategory": null } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + "/orgs/{org}/teams/{team_slug}/discussions": { "get": { - "summary": "List reactions for a team discussion comment", - "description": "List the reactions to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.", + "summary": "List discussions", + "description": "List all discussions on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions`.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-comment-in-org", + "operationId": "teams/list-discussions-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#list-reactions-for-a-team-discussion-comment" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#list-discussions" }, "parameters": [ { @@ -54219,38 +57293,17 @@ } }, { - "name": "discussion_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "comment_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "asc", + "desc" + ], + "default": "desc" } }, { @@ -54280,19 +57333,11 @@ "schema": { "type": "array", "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Discussion", + "description": "A team discussion is a persistent record of a free-form conversation within a team.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { + "author": { "nullable": true, "allOf": [ { @@ -54409,43 +57454,159 @@ } ] }, - "content": { - "description": "The reaction to use", - "example": "heart", + "body": { + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", + "type": "string" + }, + "body_html": { "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "example": "

Hi! This is an area for us to collaborate as a team

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" }, "created_at": { "type": "string", "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "example": "2018-01-25T18:56:31Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" + }, + "node_id": { + "type": "string", + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" + }, + "number": { + "description": "The unique sequence number of a team discussion.", + "example": 42, + "type": "integer" + }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization administrators.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-25T18:56:31Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "author", + "body", + "body_html", + "body_version", + "comments_count", + "comments_url", + "created_at", + "last_edited_at", + "html_url", + "pinned", + "private", + "node_id", + "number", + "team_url", + "title", + "updated_at", + "url" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -54465,8 +57626,34 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "body": "Hi! This is an area for us to collaborate as a team.", + "body_html": "

Hi! This is an area for us to collaborate as a team

", + "body_version": "0d495416a700fb06133c612575d92bfb", + "comments_count": 0, + "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", + "created_at": "2018-01-25T18:56:31Z", + "last_edited_at": null, + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", + "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", + "number": 1, + "pinned": false, + "private": false, + "team_url": "https://api.github.com/teams/2343027", + "title": "Our first team post", + "updated_at": "2018-01-25T18:56:31Z", + "url": "https://api.github.com/teams/2343027/discussions/1", + "reactions": { + "url": "https://api.github.com/teams/2343027/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } } ] } @@ -54488,25 +57675,25 @@ "enabledForGitHubApps": true, "previews": [ { - "required": true, + "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." } ], - "category": "reactions", - "subcategory": null + "category": "teams", + "subcategory": "discussions" } }, "post": { - "summary": "Create reaction for a team discussion comment", - "description": "Create a reaction to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.", + "summary": "Create a discussion", + "description": "Creates a new discussion post on a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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 abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions`.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/create-for-team-discussion-comment-in-org", + "operationId": "teams/create-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#create-reaction-for-a-team-discussion-comment" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-discussion" }, "parameters": [ { @@ -54525,22 +57712,6 @@ "schema": { "type": "string" } - }, - { - "name": "discussion_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "comment_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } } ], "requestBody": { @@ -54549,27 +57720,28 @@ "schema": { "type": "object", "properties": { - "content": { + "title": { "type": "string", - "description": "The [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types) to add to the team discussion comment.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] + "description": "The discussion post's title." + }, + "body": { + "type": "string", + "description": "The discussion post's body text." + }, + "private": { + "type": "boolean", + "description": "Private posts are only visible to team members, organization owners, and team maintainers. Public posts are visible to all members of the organization. Set to `true` to create a private post.", + "default": false } }, "required": [ - "content" + "title", + "body" ] }, "example": { - "content": "heart" + "title": "Our first team post", + "body": "Hi! This is an area for us to collaborate as a team." } } } @@ -54580,19 +57752,11 @@ "content": { "application/json": { "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Discussion", + "description": "A team discussion is a persistent record of a free-form conversation within a team.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { + "author": { "nullable": true, "allOf": [ { @@ -54709,41 +57873,157 @@ } ] }, - "content": { - "description": "The reaction to use", - "example": "heart", + "body": { + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", + "type": "string" + }, + "body_html": { "type": "string", - "enum": [ + "example": "

Hi! This is an area for us to collaborate as a team

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-25T18:56:31Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" + }, + "node_id": { + "type": "string", + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" + }, + "number": { + "description": "The unique sequence number of a team discussion.", + "example": 42, + "type": "integer" + }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization administrators.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-25T18:56:31Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", - "rocket", - "eyes" + "eyes", + "rocket" ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" } }, "required": [ - "id", + "author", + "body", + "body_html", + "body_version", + "comments_count", + "comments_url", + "created_at", + "last_edited_at", + "html_url", + "pinned", + "private", "node_id", - "user", - "content", - "created_at" + "number", + "team_url", + "title", + "updated_at", + "url" ] }, "examples": { "default": { "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -54763,8 +58043,34 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" + "body": "Hi! This is an area for us to collaborate as a team.", + "body_html": "

Hi! This is an area for us to collaborate as a team

", + "body_version": "0d495416a700fb06133c612575d92bfb", + "comments_count": 0, + "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", + "created_at": "2018-01-25T18:56:31Z", + "last_edited_at": null, + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", + "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", + "number": 1, + "pinned": false, + "private": false, + "team_url": "https://api.github.com/teams/2343027", + "title": "Our first team post", + "updated_at": "2018-01-25T18:56:31Z", + "url": "https://api.github.com/teams/2343027/discussions/1", + "reactions": { + "url": "https://api.github.com/teams/2343027/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } } } } @@ -54773,106 +58079,32 @@ } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ { - "required": true, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." - } - ], - "category": "reactions", - "subcategory": null - } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { - "delete": { - "summary": "Delete team discussion comment reaction", - "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", - "tags": [ - "reactions" - ], - "operationId": "reactions/delete-for-team-discussion-comment", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#delete-team-discussion-comment-reaction" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "comment_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "reaction_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Empty response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, + "required": false, "name": "squirrel-girl", "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." } ], - "category": "reactions", - "subcategory": null + "category": "teams", + "subcategory": "discussions" } } }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}": { "get": { - "summary": "List reactions for a team discussion", - "description": "List the reactions to a [team discussion](https://docs.github.com/github-ae@latest/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.", + "summary": "Get a discussion", + "description": "Get a specific discussion on a team's page. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/list-for-team-discussion-in-org", + "operationId": "teams/get-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#list-reactions-for-a-team-discussion" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#get-a-discussion" }, "parameters": [ { @@ -54899,43 +58131,6 @@ "schema": { "type": "integer" } - }, - { - "name": "content", - "description": "Returns a single [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } } ], "responses": { @@ -54944,313 +58139,11 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "content": { - "description": "The reaction to use", - "example": "heart", - "type": "string", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" - } - }, - "required": [ - "id", - "node_id", - "user", - "content", - "created_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." - } - ], - "category": "reactions", - "subcategory": null - } - }, - "post": { - "summary": "Create reaction for a team discussion", - "description": "Create a reaction to a [team discussion](https://docs.github.com/github-ae@latest/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.", - "tags": [ - "reactions" - ], - "operationId": "reactions/create-for-team-discussion-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#create-reaction-for-a-team-discussion" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "discussion_number", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "The [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types) to add to the team discussion.", - "enum": [ - "+1", - "-1", - "laugh", - "confused", - "heart", - "hooray", - "rocket", - "eyes" - ] - } - }, - "required": [ - "content" - ] - }, - "example": { - "content": "heart" - } - } - } - }, - "responses": { - "201": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "Reaction", - "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "title": "Team Discussion", + "description": "A team discussion is a persistent record of a free-form conversation within a team.", "type": "object", "properties": { - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDg6UmVhY3Rpb24x" - }, - "user": { + "author": { "nullable": true, "allOf": [ { @@ -55367,41 +58260,157 @@ } ] }, - "content": { - "description": "The reaction to use", - "example": "heart", + "body": { + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", + "type": "string" + }, + "body_html": { "type": "string", - "enum": [ + "example": "

Hi! This is an area for us to collaborate as a team

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-25T18:56:31Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" + }, + "node_id": { + "type": "string", + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" + }, + "number": { + "description": "The unique sequence number of a team discussion.", + "example": 42, + "type": "integer" + }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization administrators.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-25T18:56:31Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", "+1", "-1", "laugh", "confused", "heart", "hooray", - "rocket", - "eyes" + "eyes", + "rocket" ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-05-20T20:09:31Z" } }, "required": [ - "id", + "author", + "body", + "body_html", + "body_version", + "comments_count", + "comments_url", + "created_at", + "last_edited_at", + "html_url", + "pinned", + "private", "node_id", - "user", - "content", - "created_at" + "number", + "team_url", + "title", + "updated_at", + "url" ] }, "examples": { "default": { "value": { - "id": 1, - "node_id": "MDg6UmVhY3Rpb24x", - "user": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -55421,41 +58430,65 @@ "type": "User", "site_admin": false }, - "content": "heart", - "created_at": "2016-05-20T20:09:31Z" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": false, - "previews": [ - { - "required": true, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." + "body": "Hi! This is an area for us to collaborate as a team.", + "body_html": "

Hi! This is an area for us to collaborate as a team

", + "body_version": "0d495416a700fb06133c612575d92bfb", + "comments_count": 0, + "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", + "created_at": "2018-01-25T18:56:31Z", + "last_edited_at": null, + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", + "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", + "number": 1, + "pinned": false, + "private": false, + "team_url": "https://api.github.com/teams/2343027", + "title": "Our first team post", + "updated_at": "2018-01-25T18:56:31Z", + "url": "https://api.github.com/teams/2343027/discussions/1", + "reactions": { + "url": "https://api.github.com/teams/2343027/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." } ], - "category": "reactions", - "subcategory": null + "category": "teams", + "subcategory": "discussions" } - } - }, - "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { - "delete": { - "summary": "Delete team discussion reaction", - "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/github-ae@latest/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + }, + "patch": { + "summary": "Update a discussion", + "description": "Edits the title and body text of a discussion post. Only the parameters you provide are updated. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.", "tags": [ - "reactions" + "teams" ], - "operationId": "reactions/delete-for-team-discussion", + "operationId": "teams/update-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#delete-team-discussion-reaction" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#update-a-discussion" }, "parameters": [ { @@ -55482,9 +58515,407 @@ "schema": { "type": "integer" } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "title": { + "type": "string", + "description": "The discussion post's title." + }, + "body": { + "type": "string", + "description": "The discussion post's body text." + } + } + }, + "example": { + "title": "Welcome to our first team post" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Team Discussion", + "description": "A team discussion is a persistent record of a free-form conversation within a team.", + "type": "object", + "properties": { + "author": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "body": { + "description": "The main text of the discussion.", + "example": "Please suggest improvements to our workflow in comments.", + "type": "string" + }, + "body_html": { + "type": "string", + "example": "

Hi! This is an area for us to collaborate as a team

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "comments_count": { + "type": "integer", + "example": 0 + }, + "comments_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1/comments" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-25T18:56:31Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1" + }, + "node_id": { + "type": "string", + "example": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==" + }, + "number": { + "description": "The unique sequence number of a team discussion.", + "example": 42, + "type": "integer" + }, + "pinned": { + "description": "Whether or not this discussion should be pinned for easy retrieval.", + "example": true, + "type": "boolean" + }, + "private": { + "description": "Whether or not this discussion should be restricted to team members and organization administrators.", + "example": true, + "type": "boolean" + }, + "team_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027" + }, + "title": { + "description": "The title of the discussion.", + "example": "How can we improve our workflow?", + "type": "string" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-25T18:56:31Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2343027/discussions/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "author", + "body", + "body_html", + "body_version", + "comments_count", + "comments_url", + "created_at", + "last_edited_at", + "html_url", + "pinned", + "private", + "node_id", + "number", + "team_url", + "title", + "updated_at", + "url" + ] + }, + "examples": { + "default": { + "value": { + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Hi! This is an area for us to collaborate as a team.", + "body_html": "

Hi! This is an area for us to collaborate as a team

", + "body_version": "0d495416a700fb06133c612575d92bfb", + "comments_count": 1, + "comments_url": "https://api.github.com/teams/2343027/discussions/1/comments", + "created_at": "2018-01-25T18:56:31Z", + "last_edited_at": "2018-01-26T18:22:20Z", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1", + "node_id": "MDE0OlRlYW1EaXNjdXNzaW9uMQ==", + "number": 1, + "pinned": false, + "private": false, + "team_url": "https://api.github.com/teams/2343027", + "title": "Welcome to our first team post", + "updated_at": "2018-01-26T18:22:20Z", + "url": "https://api.github.com/teams/2343027/discussions/1", + "reactions": { + "url": "https://api.github.com/teams/2343027/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." + } + ], + "category": "teams", + "subcategory": "discussions" + } + }, + "delete": { + "summary": "Delete a discussion", + "description": "Delete a discussion from a team's page. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}`.", + "tags": [ + "teams" + ], + "operationId": "teams/delete-discussion-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#delete-a-discussion" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } }, { - "name": "reaction_id", + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discussion_number", "in": "path", "required": true, "schema": { @@ -55501,28 +58932,24 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": true, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." - } + ], - "category": "reactions", - "subcategory": null + "category": "teams", + "subcategory": "discussions" } } }, - "/orgs/{org}/teams/{team_slug}/members": { + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments": { "get": { - "summary": "List team members", - "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "summary": "List discussion comments", + "description": "List all comments on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", "tags": [ "teams" ], - "operationId": "teams/list-members-in-org", + "operationId": "teams/list-discussion-comments-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#list-team-members" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#list-discussion-comments" }, "parameters": [ { @@ -55543,18 +58970,25 @@ } }, { - "name": "role", - "description": "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.", + "name": "discussion_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "direction", + "description": "One of `asc` (ascending) or `desc` (descending).", "in": "query", "required": false, "schema": { "type": "string", "enum": [ - "member", - "maintainer", - "all" + "asc", + "desc" ], - "default": "all" + "default": "desc" } }, { @@ -55584,140 +59018,293 @@ "schema": { "type": "array", "items": { - "title": "Simple User", - "description": "Simple User", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "login": { - "type": "string", - "example": "octocat" + "author": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] }, - "id": { - "type": "integer", - "example": 1 + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" }, - "node_id": { + "body_html": { "type": "string", - "example": "MDQ6VXNlcjE=" + "example": "

Do you like apples?

" }, - "avatar_url": { + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "format": "date-time", + "example": "2018-01-15T23:53:58Z" }, - "gravatar_id": { + "last_edited_at": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", + "format": "date-time", "nullable": true }, - "url": { + "discussion_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" }, "html_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" }, - "organizations_url": { + "node_id": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" }, - "events_url": { + "updated_at": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "date-time", + "example": "2018-01-15T23:53:58Z" }, - "received_events_url": { + "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", "html_url", - "id", "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", + "number", + "updated_at", "url" - ], - "nullable": true + ] } }, "examples": { "default": { "value": [ { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Do you like apples?", + "body_html": "

Do you like apples?

", + "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", + "created_at": "2018-01-15T23:53:58Z", + "last_edited_at": null, + "discussion_url": "https://api.github.com/teams/2403582/discussions/1", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", + "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", + "number": 1, + "updated_at": "2018-01-15T23:53:58Z", + "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", + "reactions": { + "url": "https://api.github.com/teams/2403582/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 + } } ] } @@ -55738,139 +59325,26 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - - ], - "category": "teams", - "subcategory": "members" - } - } - }, - "/orgs/{org}/teams/{team_slug}/memberships/{username}": { - "get": { - "summary": "Get team membership for a user", - "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-team).", - "tags": [ - "teams" - ], - "operationId": "teams/get-membership-for-user-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#get-team-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "Team Membership", - "description": "Team Membership", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "example": "member", - "type": "string" - }, - "state": { - "type": "string" - } - }, - "required": [ - "role", - "state", - "url" - ] - }, - "examples": { - "response-if-user-has-an-active-membership-with-team": { - "summary": "Response if user has an active membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, - "response-if-user-is-a-team-maintainer": { - "summary": "Response if user is a team maintainer", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "maintainer", - "state": "active" - } - }, - "response-if-user-has-a-pending-membership-with-team": { - "summary": "Response if user has a pending membership with team", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } - } - } - } + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." } - }, - "404": { - "description": "Response if user has no team membership" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - ], "category": "teams", - "subcategory": "members" + "subcategory": "discussion-comments" } }, - "put": { - "summary": "Add or update team membership for a user", - "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\n**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 AE 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 AE](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "post": { + "summary": "Create a discussion comment", + "description": "Creates a new comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\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 abuse rate limiting. See \"[Abuse rate limits](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#abuse-rate-limits)\" and \"[Dealing with abuse rate limits](https://docs.github.com/github-ae@latest/rest/guides/best-practices-for-integrators#dealing-with-rate-limits)\" for details.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments`.", "tags": [ "teams" ], - "operationId": "teams/add-or-update-membership-for-user-in-org", + "operationId": "teams/create-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#add-or-update-team-membership-for-a-user" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-discussion-comment" }, "parameters": [ { @@ -55891,11 +59365,11 @@ } }, { - "name": "username", + "name": "discussion_number", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -55905,203 +59379,346 @@ "schema": { "type": "object", "properties": { - "role": { + "body": { "type": "string", - "description": "The role that this user should have in the team. Can be one of: \n\\* `member` - a normal member of the team. \n\\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.", - "enum": [ - "member", - "maintainer" - ], - "default": "member" + "description": "The discussion comment's body text." } - } + }, + "required": [ + "body" + ] + }, + "example": { + "body": "Do you like apples?" } } } }, "responses": { - "200": { + "201": { "description": "response", "content": { "application/json": { "schema": { - "title": "Team Membership", - "description": "Team Membership", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri" - }, - "role": { - "description": "The role of the user in the team.", - "enum": [ - "member", - "maintainer" - ], - "default": "member", - "example": "member", - "type": "string" - }, - "state": { - "type": "string" - } + "author": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { + "type": "string", + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" + }, + "total_count": { + "type": "integer" + }, + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } }, "required": [ - "role", - "state", + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", + "node_id", + "number", + "updated_at", "url" ] }, "examples": { - "response-if-users-membership-with-team-is-now-active": { - "summary": "Response if user's membership with team is now active", - "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "active" - } - }, - "response-if-users-membership-with-team-is-now-pending": { - "summary": "Response if user's membership with team is now pending", + "default": { "value": { - "url": "https://api.github.com/teams/1/memberships/octocat", - "role": "member", - "state": "pending" - } - } - } - } - } - }, - "403": { - "description": "Response if team synchronization is set up" - }, - "422": { - "description": "Response if you attempt to add an organization to a team", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "field": { - "type": "string" - }, - "resource": { - "type": "string" - } - } + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Do you like apples?", + "body_html": "

Do you like apples?

", + "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", + "created_at": "2018-01-15T23:53:58Z", + "last_edited_at": null, + "discussion_url": "https://api.github.com/teams/2403582/discussions/1", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", + "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", + "number": 1, + "updated_at": "2018-01-15T23:53:58Z", + "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", + "reactions": { + "url": "https://api.github.com/teams/2403582/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 } } } - }, - "examples": { - "response-if-you-attempt-to-add-an-organization-to-a-team": { - "value": { - "message": "Cannot add an organization as a member.", - "errors": [ - { - "code": "org", - "field": "user", - "resource": "TeamMember" - } - ] - } - } } } } } }, "x-github": { + "triggersNotification": true, "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - - ], - "category": "teams", - "subcategory": "members" - } - }, - "delete": { - "summary": "Remove team membership for a user", - "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**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 AE 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 AE](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-membership-for-user-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#remove-team-membership-for-a-user" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "username", - "in": "path", - "required": true, - "schema": { - "type": "string" + { + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." } - } - ], - "responses": { - "204": { - "description": "Empty response" - }, - "403": { - "description": "Response if team synchronization is set up" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - ], "category": "teams", - "subcategory": "members" + "subcategory": "discussion-comments" } } }, - "/orgs/{org}/teams/{team_slug}/projects": { + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}": { "get": { - "summary": "List team projects", - "description": "Lists the organization projects for a team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.", + "summary": "Get a discussion comment", + "description": "Get a specific comment on a team discussion. OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.", "tags": [ "teams" ], - "operationId": "teams/list-projects-in-org", + "operationId": "teams/get-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#list-team-projects" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#get-a-discussion-comment" }, "parameters": [ { @@ -56122,21 +59739,19 @@ } }, { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", + "name": "discussion_number", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 30 + "type": "integer" } }, { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", + "name": "comment_number", + "in": "path", + "required": true, "schema": { - "type": "integer", - "default": 1 + "type": "integer" } } ], @@ -56146,263 +59761,295 @@ "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Team Project", - "description": "A team's access to a project.", - "type": "object", - "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "body": { - "type": "string", - "nullable": true - }, - "number": { - "type": "integer" - }, - "state": { - "type": "string" - }, - "creator": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", + "type": "object", + "properties": { + "author": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", + "type": "string" + }, + "body_html": { + "type": "string", + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, + "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, + "type": "integer" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" - }, - "write": { - "type": "boolean" - }, - "admin": { - "type": "boolean" - } + "total_count": { + "type": "integer" }, - "required": [ - "read", - "write", - "admin" - ] - } - }, - "required": [ - "owner_url", - "url", - "html_url", - "columns_url", - "id", - "node_id", - "name", - "body", - "number", - "state", - "creator", - "created_at", - "updated_at", - "permissions" - ] - } + "+1": { + "type": "integer" + }, + "-1": { + "type": "integer" + }, + "laugh": { + "type": "integer" + }, + "confused": { + "type": "integer" + }, + "heart": { + "type": "integer" + }, + "hooray": { + "type": "integer" + }, + "eyes": { + "type": "integer" + }, + "rocket": { + "type": "integer" + } + }, + "required": [ + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" + ] + } + }, + "required": [ + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", + "html_url", + "node_id", + "number", + "updated_at", + "url" + ] }, "examples": { "default": { - "value": [ - { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false - } + "value": { + "author": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "body": "Do you like apples?", + "body_html": "

Do you like apples?

", + "body_version": "5eb32b219cdc6a5a9b29ba5d6caa9c51", + "created_at": "2018-01-15T23:53:58Z", + "last_edited_at": null, + "discussion_url": "https://api.github.com/teams/2403582/discussions/1", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", + "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", + "number": 1, + "updated_at": "2018-01-15T23:53:58Z", + "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", + "reactions": { + "url": "https://api.github.com/teams/2403582/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 } - ] + } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } } } }, @@ -56411,27 +60058,25 @@ "enabledForGitHubApps": true, "previews": [ { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." } ], "category": "teams", - "subcategory": null + "subcategory": "discussion-comments" } - } - }, - "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { - "get": { - "summary": "Check team permissions for a project", - "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + }, + "patch": { + "summary": "Update a discussion comment", + "description": "Edits the body text of a discussion comment. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PATCH /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.", "tags": [ "teams" ], - "operationId": "teams/check-permissions-for-project-in-org", + "operationId": "teams/update-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#check-team-permissions-for-a-project" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#update-a-discussion-comment" }, "parameters": [ { @@ -56452,7 +60097,15 @@ } }, { - "name": "project_id", + "name": "discussion_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "comment_number", "in": "path", "required": true, "schema": { @@ -56460,224 +60113,276 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "body": { + "type": "string", + "description": "The discussion comment's body text." + } + }, + "required": [ + "body" + ] + }, + "example": { + "body": "Do you like pineapples?" + } + } + } + }, "responses": { "200": { "description": "response", "content": { "application/json": { "schema": { - "title": "Team Project", - "description": "A team's access to a project.", + "title": "Team Discussion Comment", + "description": "A reply to a discussion within a team.", "type": "object", "properties": { - "owner_url": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "columns_url": { - "type": "string" - }, - "id": { - "type": "integer" + "author": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] }, - "node_id": { + "body": { + "description": "The main text of the comment.", + "example": "I agree with this suggestion.", "type": "string" }, - "name": { + "body_html": { + "type": "string", + "example": "

Do you like apples?

" + }, + "body_version": { + "description": "The current version of the body content. If provided, this update operation will be rejected if the given version does not match the latest version on the server.", + "example": "0307116bbf7ced493b8d8a346c650b71", "type": "string" }, - "body": { + "created_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" + }, + "last_edited_at": { "type": "string", + "format": "date-time", "nullable": true }, + "discussion_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1" + }, + "node_id": { + "type": "string", + "example": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=" + }, "number": { + "description": "The unique sequence number of a team discussion comment.", + "example": 42, "type": "integer" }, - "state": { - "type": "string" + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2018-01-15T23:53:58Z" }, - "creator": { - "title": "Simple User", - "description": "Simple User", + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/2403582/discussions/1/comments/1" + }, + "reactions": { + "title": "Reaction Rollup", "type": "object", "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, "url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "format": "uri" }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "total_count": { + "type": "integer" }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "+1": { + "type": "integer" }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "-1": { + "type": "integer" }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "laugh": { + "type": "integer" }, - "type": { - "type": "string", - "example": "User" + "confused": { + "type": "integer" }, - "site_admin": { - "type": "boolean" + "heart": { + "type": "integer" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "organization_permission": { - "description": "The organization permission for this project. Only present when owner is an organization.", - "type": "string" - }, - "private": { - "description": "Whether the project is private or not. Only present when owner is an organization.", - "type": "boolean" - }, - "permissions": { - "type": "object", - "properties": { - "read": { - "type": "boolean" + "hooray": { + "type": "integer" }, - "write": { - "type": "boolean" + "eyes": { + "type": "integer" }, - "admin": { - "type": "boolean" + "rocket": { + "type": "integer" } }, "required": [ - "read", - "write", - "admin" + "url", + "total_count", + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "eyes", + "rocket" ] } }, "required": [ - "owner_url", - "url", + "author", + "body", + "body_html", + "body_version", + "created_at", + "last_edited_at", + "discussion_url", "html_url", - "columns_url", - "id", "node_id", - "name", - "body", "number", - "state", - "creator", - "created_at", "updated_at", - "permissions" + "url" ] }, "examples": { "default": { "value": { - "owner_url": "https://api.github.com/orgs/octocat", - "url": "https://api.github.com/projects/1002605", - "html_url": "https://github.com/orgs/api-playground/projects/1", - "columns_url": "https://api.github.com/projects/1002605/columns", - "id": 1002605, - "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", - "name": "Organization Roadmap", - "body": "High-level roadmap for the upcoming year.", - "number": 1, - "state": "open", - "creator": { + "author": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -56697,23 +60402,34 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-11T20:09:31Z", - "updated_at": "2014-03-04T18:58:10Z", - "organization_permission": "write", - "private": false, - "permissions": { - "read": true, - "write": true, - "admin": false + "body": "Do you like pineapples?", + "body_html": "

Do you like pineapples?

", + "body_version": "e6907b24d9c93cc0c5024a7af5888116", + "created_at": "2018-01-15T23:53:58Z", + "last_edited_at": "2018-01-26T18:22:20Z", + "discussion_url": "https://api.github.com/teams/2403582/discussions/1", + "html_url": "https://github.com/orgs/github/teams/justice-league/discussions/1/comments/1", + "node_id": "MDIxOlRlYW1EaXNjdXNzaW9uQ29tbWVudDE=", + "number": 1, + "updated_at": "2018-01-26T18:22:20Z", + "url": "https://api.github.com/teams/2403582/discussions/1/comments/1", + "reactions": { + "url": "https://api.github.com/teams/2403582/discussions/1/reactions", + "total_count": 5, + "+1": 3, + "-1": 1, + "laugh": 0, + "confused": 0, + "heart": 1, + "hooray": 0, + "eyes": 1, + "rocket": 1 } } } } } } - }, - "404": { - "description": "Response if project is not managed by this team" } }, "x-github": { @@ -56721,25 +60437,25 @@ "enabledForGitHubApps": true, "previews": [ { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + "required": false, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." } ], "category": "teams", - "subcategory": null + "subcategory": "discussion-comments" } }, - "put": { - "summary": "Add or update team project permissions", - "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "delete": { + "summary": "Delete a discussion comment", + "description": "Deletes a comment on a team discussion. OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/discussions/{discussion_number}/comments/{comment_number}`.", "tags": [ "teams" ], - "operationId": "teams/add-or-update-project-permissions-in-org", + "operationId": "teams/delete-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#add-or-update-team-project-permissions" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#delete-a-discussion-comment" }, "parameters": [ { @@ -56760,90 +60476,49 @@ } }, { - "name": "project_id", + "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. 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](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"", - "enum": [ - "read", - "write", - "admin" - ] - } - }, - "nullable": true - } + }, + { + "name": "comment_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } - }, + ], "responses": { "204": { "description": "Empty response" - }, - "403": { - "description": "Response if the project is not owned by the organization", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - }, - "examples": { - "response-if-the-project-is-not-owned-by-the-organization": { - "value": { - "message": "Must have admin rights to Repository.", - "documentation_url": "https://docs.github.com/github-ae@latest/rest/reference/teams#add-or-update-team-project-permissions" - } - } - } - } - } } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" - } + ], "category": "teams", - "subcategory": null + "subcategory": "discussion-comments" } - }, - "delete": { - "summary": "Remove a project from a team", - "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + } + }, + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions": { + "get": { + "summary": "List reactions for a team discussion comment", + "description": "List the reactions to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments/). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.", "tags": [ - "teams" + "reactions" ], - "operationId": "teams/remove-project-in-org", + "operationId": "reactions/list-for-team-discussion-comment-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#remove-a-project-from-a-team" + "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#list-reactions-for-a-team-discussion-comment" }, "parameters": [ { @@ -56864,58 +60539,38 @@ } }, { - "name": "project_id", + "name": "discussion_number", "in": "path", "required": true, "schema": { "type": "integer" } - } - ], - "responses": { - "204": { - "description": "Empty response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - - ], - "category": "teams", - "subcategory": null - } - } - }, - "/orgs/{org}/teams/{team_slug}/repos": { - "get": { - "summary": "List team repositories", - "description": "Lists a team's repositories visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", - "tags": [ - "teams" - ], - "operationId": "teams/list-repos-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#list-team-repositories" - }, - "parameters": [ + }, { - "name": "org", + "name": "comment_number", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } }, { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, + "name": "content", + "description": "Returns a single [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion comment.", + "in": "query", + "required": false, "schema": { - "type": "string" + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] } }, { @@ -56945,28 +60600,19 @@ "schema": { "type": "array", "items": { - "title": "Minimal Repository", - "description": "Minimal Repository", + "title": "Reaction", + "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { "type": "integer", - "example": 1296269 + "example": 1 }, "node_id": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" + "example": "MDg6UmVhY3Rpb24x" }, - "owner": { - "type": "object", + "user": { "nullable": true, "allOf": [ { @@ -57083,1352 +60729,699 @@ } ] }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { + "content": { + "description": "The reaction to use", + "example": "heart", "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] }, "created_at": { "type": "string", "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "template_repository": { - "nullable": true, - "type": "object", - "allOf": [ - { - "title": "Repository", - "description": "A git repository", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "nullable": true, - "allOf": [ - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { + "example": "2016-05-20T20:09:31Z" + } + }, + "required": [ + "id", + "node_id", + "user", + "content", + "created_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + } + }, + "post": { + "summary": "Create reaction for a team discussion comment", + "description": "Create a reaction to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion comment.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions`.", + "tags": [ + "reactions" + ], + "operationId": "reactions/create-for-team-discussion-comment-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#create-reaction-for-a-team-discussion-comment" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discussion_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "comment_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types) to add to the team discussion comment.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": [ + "content" + ] + }, + "example": { + "content": "heart" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Reaction", + "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDg6UmVhY3Rpb24x" + }, + "user": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "content": { + "description": "The reaction to use", + "example": "heart", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-05-20T20:09:31Z" + } + }, + "required": [ + "id", + "node_id", + "user", + "content", + "created_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + } + } + }, + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/comments/{comment_number}/reactions/{reaction_id}": { + "delete": { + "summary": "Delete team discussion comment reaction", + "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/comments/:comment_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "tags": [ + "reactions" + ], + "operationId": "reactions/delete-for-team-discussion-comment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#delete-team-discussion-comment-reaction" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discussion_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "comment_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "reaction_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + } + } + }, + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions": { + "get": { + "summary": "List reactions for a team discussion", + "description": "List the reactions to a [team discussion](https://docs.github.com/github-ae@latest/rest/reference/teams#discussions). OAuth access tokens require the `read:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.", + "tags": [ + "reactions" + ], + "operationId": "reactions/list-for-team-discussion-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#list-reactions-for-a-team-discussion" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discussion_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "content", + "description": "Returns a single [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types). Omit this parameter to list all reactions to a team discussion.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Reaction", + "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDg6UmVhY3Rpb24x" + }, + "user": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + "example": "octocat" }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + "id": { + "type": "integer", + "example": 1 }, - "events_url": { + "node_id": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" + "example": "MDQ6VXNlcjE=" }, - "forks_url": { + "avatar_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "example": "https://github.com/images/error/octocat_happy.gif" }, - "labels_url": { + "gravatar_id": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "languages_url": { + "url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" + "example": "https://api.github.com/users/octocat" }, - "merges_url": { + "html_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" + "example": "https://github.com/octocat" }, - "stargazers_url": { + "followers_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "example": "https://api.github.com/users/octocat/followers" }, - "subscribers_url": { + "following_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "subscription_url": { + "gists_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "tags_url": { + "starred_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "teams_url": { + "subscriptions_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" + "example": "https://api.github.com/users/octocat/subscriptions" }, - "mirror_url": { + "organizations_url": { "type": "string", "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true + "example": "https://api.github.com/users/octocat/orgs" }, - "hooks_url": { + "repos_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + "example": "https://api.github.com/users/octocat/repos" }, - "svn_url": { + "events_url": { "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "homepage": { + "received_events_url": { "type": "string", "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "type": "integer", - "example": 108 + "example": "https://api.github.com/users/octocat/received_events" }, - "default_branch": { - "description": "The default branch of the repository.", + "type": { "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true + "example": "User" }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, + "site_admin": { "type": "boolean" }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { + "starred_at": { "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "template_repository": { - "nullable": true, - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "language": { - "type": "string" - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" + "example": "\"2020-07-09T00:17:55Z\"" } }, "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", + "avatar_url", "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", "html_url", "id", "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true } ] }, - "temp_clone_token": { - "type": "string" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, - "nullable": true - }, - "forks": { - "type": "integer", - "example": 0 - }, - "open_issues": { - "type": "integer", - "example": 0 + "content": { + "description": "The reaction to use", + "example": "heart", + "type": "string", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] }, - "watchers": { - "type": "integer", - "example": 0 + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-05-20T20:09:31Z" } }, "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", "id", "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url" + "user", + "content", + "created_at" ] } }, @@ -58436,11 +61429,9 @@ "default": { "value": [ { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -58460,204 +61451,8 @@ "type": "User", "site_admin": false }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World-Template", - "full_name": "octocat/Hello-World-Template", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World-Template", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World-Template", - "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World-Template.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World-Template.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World-Template.git", - "mirror_url": "git:git.example.com/octocat/Hello-World-Template", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World-Template", - "homepage": "https://github.com", - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - } + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" } ] } @@ -58678,24 +61473,26 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." + } ], - "category": "teams", + "category": "reactions", "subcategory": null } - } - }, - "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { - "get": { - "summary": "Check team permissions for a repository", - "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + }, + "post": { + "summary": "Create reaction for a team discussion", + "description": "Create a reaction to a [team discussion](https://docs.github.com/github-ae@latest/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/). A response with a `Status: 200 OK` means that you already added the reaction type to this team discussion.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `POST /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions`.", "tags": [ - "teams" + "reactions" ], - "operationId": "teams/check-permissions-for-repo-in-org", + "operationId": "reactions/create-for-team-discussion-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#check-team-permissions-for-a-repository" + "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#create-reaction-for-a-team-discussion" }, "parameters": [ { @@ -58716,125 +61513,64 @@ } }, { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", + "name": "discussion_number", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The [reaction type](https://docs.github.com/github-ae@latest/rest/reference/reactions#reaction-types) to add to the team discussion.", + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] + } + }, + "required": [ + "content" + ] + }, + "example": { + "content": "heart" + } + } + } + }, "responses": { - "200": { - "description": "Alternative response with repository permissions", + "201": { + "description": "response", "content": { - "application/vnd.github.v3.repository+json": { + "application/json": { "schema": { - "title": "Team Repository", - "description": "A team's access to a repository.", + "title": "Reaction", + "description": "Reactions to conversations provide a way to help people express their feelings more simply and effectively.", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer" + "type": "integer", + "example": 1 }, "node_id": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "nullable": true, - "allOf": [ - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "example": "MDg6UmVhY3Rpb24x" }, - "owner": { + "user": { "nullable": true, "allOf": [ { @@ -58951,2469 +61687,3474 @@ } ] }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { + "content": { + "description": "The reaction to use", + "example": "heart", "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true + "enum": [ + "+1", + "-1", + "laugh", + "confused", + "heart", + "hooray", + "rocket", + "eyes" + ] }, - "language": { + "created_at": { "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 + "format": "date-time", + "example": "2016-05-20T20:09:31Z" + } + }, + "required": [ + "id", + "node_id", + "user", + "content", + "created_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 1, + "node_id": "MDg6UmVhY3Rpb24x", + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "content": "heart", + "created_at": "2016-05-20T20:09:31Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + } + } + }, + "/orgs/{org}/teams/{team_slug}/discussions/{discussion_number}/reactions/{reaction_id}": { + "delete": { + "summary": "Delete team discussion reaction", + "description": "**Note:** You can also specify a team or organization with `team_id` and `org_id` using the route `DELETE /organizations/:org_id/team/:team_id/discussions/:discussion_number/reactions/:reaction_id`.\n\nDelete a reaction to a [team discussion](https://docs.github.com/github-ae@latest/rest/reference/teams#discussions). OAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/).", + "tags": [ + "reactions" + ], + "operationId": "reactions/delete-for-team-discussion", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#delete-team-discussion-reaction" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "discussion_number", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "reaction_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." + } + ], + "category": "reactions", + "subcategory": null + } + } + }, + "/orgs/{org}/teams/{team_slug}/members": { + "get": { + "summary": "List team members", + "description": "Team members will include the members of child teams.\n\nTo list members in a team, the team must be visible to the authenticated user.", + "tags": [ + "teams" + ], + "operationId": "teams/list-members-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#list-team-members" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "role", + "description": "Filters members returned by their role in the team. Can be one of: \n\\* `member` - normal members of the team. \n\\* `maintainer` - team maintainers. \n\\* `all` - all members of the team.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "member", + "maintainer", + "all" + ], + "default": "all" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } }, - "watchers_count": { - "type": "integer", - "example": 80 + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + }, + "examples": { + "default": { + "value": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "teams", + "subcategory": "members" + } + } + }, + "/orgs/{org}/teams/{team_slug}/memberships/{username}": { + "get": { + "summary": "Get team membership for a user", + "description": "Team members will include the members of child teams.\n\nTo get a user's membership with a team, the team must be visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/memberships/{username}`.\n\n**Note:** The `role` for organization owners returns as `maintainer`. For more information about `maintainer` roles, see [Create a team](https://docs.github.com/github-ae@latest/rest/reference/teams#create-a-team).", + "tags": [ + "teams" + ], + "operationId": "teams/get-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#get-team-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Team Membership", + "description": "Team Membership", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri" }, - "size": { - "type": "integer", - "example": 108 + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member", + "example": "member", + "type": "string" }, - "default_branch": { - "description": "The default branch of the repository.", + "state": { + "type": "string" + } + }, + "required": [ + "role", + "state", + "url" + ] + }, + "examples": { + "response-if-user-has-an-active-membership-with-team": { + "summary": "Response if user has an active membership with team", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "member", + "state": "active" + } + }, + "response-if-user-is-a-team-maintainer": { + "summary": "Response if user is a team maintainer", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "maintainer", + "state": "active" + } + }, + "response-if-user-has-a-pending-membership-with-team": { + "summary": "Response if user has a pending membership with team", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "member", + "state": "pending" + } + } + } + } + } + }, + "404": { + "description": "Response if user has no team membership" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "teams", + "subcategory": "members" + } + }, + "put": { + "summary": "Add or update team membership for a user", + "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nAdds an organization member to a team. An authenticated organization owner or team maintainer can add organization members to a team.\n\n**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 AE 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 AE](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\nAn organization owner can add someone who is not part of the team's organization to a team. When an organization owner adds someone to a team who is not an organization member, this endpoint will send an invitation to the person via email. This newly-created membership will be in the \"pending\" state until the person accepts the invitation, at which point the membership will transition to the \"active\" state and the user will be added as a member of the team.\n\nIf the user is already a member of the team, this endpoint will update the role of the team member's role. To update the membership of a team member, the authenticated user must be an organization owner or a team maintainer.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "tags": [ + "teams" + ], + "operationId": "teams/add-or-update-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#add-or-update-team-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "role": { + "type": "string", + "description": "The role that this user should have in the team. Can be one of: \n\\* `member` - a normal member of the team. \n\\* `maintainer` - a team maintainer. Able to add/remove other team members, promote other team members to team maintainer, and edit the team's name and description.", + "enum": [ + "member", + "maintainer" + ], + "default": "member" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Team Membership", + "description": "Team Membership", + "type": "object", + "properties": { + "url": { "type": "string", - "example": "master" + "format": "uri" }, - "open_issues_count": { - "type": "integer", - "example": 0 + "role": { + "description": "The role of the user in the team.", + "enum": [ + "member", + "maintainer" + ], + "default": "member", + "example": "member", + "type": "string" }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true + "state": { + "type": "string" + } + }, + "required": [ + "role", + "state", + "url" + ] + }, + "examples": { + "response-if-users-membership-with-team-is-now-active": { + "summary": "Response if user's membership with team is now active", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "member", + "state": "active" + } + }, + "response-if-users-membership-with-team-is-now-pending": { + "summary": "Response if user's membership with team is now pending", + "value": { + "url": "https://api.github.com/teams/1/memberships/octocat", + "role": "member", + "state": "pending" + } + } + } + } + } + }, + "403": { + "description": "Response if team synchronization is set up" + }, + "422": { + "description": "Response if you attempt to add an organization to a team", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" }, - "topics": { + "errors": { "type": "array", "items": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "field": { + "type": "string" + }, + "resource": { + "type": "string" + } + } + } + } + } + }, + "examples": { + "response-if-you-attempt-to-add-an-organization-to-a-team": { + "value": { + "message": "Cannot add an organization as a member.", + "errors": [ + { + "code": "org", + "field": "user", + "resource": "TeamMember" + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "teams", + "subcategory": "members" + } + }, + "delete": { + "summary": "Remove team membership for a user", + "description": "Team synchronization is available for organizations using GitHub Enterprise Cloud. For more information, see [GitHub's products](https://help.github.com/github/getting-started-with-github/githubs-products) in the GitHub Help documentation.\n\nTo remove a membership between a user and a team, the authenticated user must have 'admin' permissions to the team or be an owner of the organization that the team is associated with. Removing team membership does not delete the user, it just removes their membership from the team.\n\n**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 AE 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 AE](https://help.github.com/articles/synchronizing-teams-between-your-identity-provider-and-github/).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/memberships/{username}`.", + "tags": [ + "teams" + ], + "operationId": "teams/remove-membership-for-user-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams#remove-team-membership-for-a-user" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + }, + "403": { + "description": "Response if team synchronization is set up" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "teams", + "subcategory": "members" + } + } + }, + "/orgs/{org}/teams/{team_slug}/projects": { + "get": { + "summary": "List team projects", + "description": "Lists the organization projects for a team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects`.", + "tags": [ + "teams" + ], + "operationId": "teams/list-projects-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#list-team-projects" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Team Project", + "description": "A team's access to a project.", + "type": "object", + "properties": { + "owner_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "columns_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "number": { + "type": "integer" + }, + "state": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "organization_permission": { + "description": "The organization permission for this project. Only present when owner is an organization.", "type": "string" + }, + "private": { + "description": "Whether the project is private or not. Only present when owner is an organization.", + "type": "boolean" + }, + "permissions": { + "type": "object", + "properties": { + "read": { + "type": "boolean" + }, + "write": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "read", + "write", + "admin" + ] } }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "template_repository": { - "type": "object", - "nullable": true, - "allOf": [ - { - "title": "Repository", - "description": "A git repository", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "nullable": true, - "allOf": [ - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } + "required": [ + "owner_url", + "url", + "html_url", + "columns_url", + "id", + "node_id", + "name", + "body", + "number", + "state", + "creator", + "created_at", + "updated_at", + "permissions" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z", + "organization_permission": "write", + "private": false, + "permissions": { + "read": true, + "write": true, + "admin": false + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "teams", + "subcategory": null + } + } + }, + "/orgs/{org}/teams/{team_slug}/projects/{project_id}": { + "get": { + "summary": "Check team permissions for a project", + "description": "Checks whether a team has `read`, `write`, or `admin` permissions for an organization project. The response includes projects inherited from a parent team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "tags": [ + "teams" + ], + "operationId": "teams/check-permissions-for-project-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#check-team-permissions-for-a-project" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Team Project", + "description": "A team's access to a project.", + "type": "object", + "properties": { + "owner_url": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "columns_url": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "body": { + "type": "string", + "nullable": true + }, + "number": { + "type": "integer" + }, + "state": { + "type": "string" + }, + "creator": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "organization_permission": { + "description": "The organization permission for this project. Only present when owner is an organization.", + "type": "string" + }, + "private": { + "description": "Whether the project is private or not. Only present when owner is an organization.", + "type": "boolean" + }, + "permissions": { + "type": "object", + "properties": { + "read": { + "type": "boolean" + }, + "write": { + "type": "boolean" + }, + "admin": { + "type": "boolean" + } + }, + "required": [ + "read", + "write", + "admin" + ] + } + }, + "required": [ + "owner_url", + "url", + "html_url", + "columns_url", + "id", + "node_id", + "name", + "body", + "number", + "state", + "creator", + "created_at", + "updated_at", + "permissions" + ] + }, + "examples": { + "default": { + "value": { + "owner_url": "https://api.github.com/orgs/octocat", + "url": "https://api.github.com/projects/1002605", + "html_url": "https://github.com/orgs/api-playground/projects/1", + "columns_url": "https://api.github.com/projects/1002605/columns", + "id": 1002605, + "node_id": "MDc6UHJvamVjdDEwMDI2MDU=", + "name": "Organization Roadmap", + "body": "High-level roadmap for the upcoming year.", + "number": 1, + "state": "open", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-11T20:09:31Z", + "updated_at": "2014-03-04T18:58:10Z", + "organization_permission": "write", + "private": false, + "permissions": { + "read": true, + "write": true, + "admin": false + } + } + } + } + } + } + }, + "404": { + "description": "Response if project is not managed by this team" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "teams", + "subcategory": null + } + }, + "put": { + "summary": "Add or update team project permissions", + "description": "Adds an organization project to a team. To add a project to a team or update the team's permission on a project, the authenticated user must have `admin` permissions for the project. The project and team must be part of the same organization.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "tags": [ + "teams" + ], + "operationId": "teams/add-or-update-project-permissions-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#add-or-update-team-project-permissions" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "permission": { + "type": "string", + "description": "The permission to grant to the team for this project. Can be one of: \n\\* `read` - team members can read, but not write to or administer this project. \n\\* `write` - team members can read and write, but not administer this project. \n\\* `admin` - team members can read, write and administer this project. \nDefault: the team's `permission` attribute will be used to determine what permission to grant the team on this project. 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](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"", + "enum": [ + "read", + "write", + "admin" + ] + } + }, + "nullable": true + } + } + } + }, + "responses": { + "204": { + "description": "Empty response" + }, + "403": { + "description": "Response if the project is not owned by the organization", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + }, + "examples": { + "response-if-the-project-is-not-owned-by-the-organization": { + "value": { + "message": "Must have admin rights to Repository.", + "documentation_url": "https://docs.github.com/github-ae@latest/rest/reference/teams#add-or-update-team-project-permissions" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "teams", + "subcategory": null + } + }, + "delete": { + "summary": "Remove a project from a team", + "description": "Removes an organization project from a team. An organization owner or a team maintainer can remove any project from the team. To remove a project from a team as an organization member, the authenticated user must have `read` access to both the team and project, or `admin` access to the team or project. This endpoint removes the project from the team, but does not delete the project.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/projects/{project_id}`.", + "tags": [ + "teams" + ], + "operationId": "teams/remove-project-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#remove-a-project-from-a-team" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "project_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "teams", + "subcategory": null + } + } + }, + "/orgs/{org}/teams/{team_slug}/repos": { + "get": { + "summary": "List team repositories", + "description": "Lists a team's repositories visible to the authenticated user.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos`.", + "tags": [ + "teams" + ], + "operationId": "teams/list-repos-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#list-team-repositories" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "type": "object", + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "template_repository": { - "nullable": true, - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "template_repository": { + "nullable": true, + "type": "object", + "allOf": [ + { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } }, - "site_admin": { - "type": "boolean" - } + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] } - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "language": { - "type": "string" - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" } }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "push": { - "type": "boolean" + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } }, - "pull": { - "type": "boolean" - } - } - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - } - ] - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "examples": { - "alternative-response-with-repository-permissions": { - "value": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World-Template", - "full_name": "octocat/Hello-World-Template", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World-Template", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World-Template", - "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World-Template.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World-Template.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World-Template.git", - "mirror_url": "git:git.example.com/octocat/Hello-World-Template", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World-Template", - "homepage": "https://github.com", - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - } - } - } - } - } - }, - "204": { - "description": "Response if team has permission for the repository" - }, - "404": { - "description": "Response if team does not have permission for the repository" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - - ], - "category": "teams", - "subcategory": null - } - }, - "put": { - "summary": "Add or update team repository permissions", - "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", - "tags": [ - "teams" - ], - "operationId": "teams/add-or-update-repo-permissions-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#add-or-update-team-repository-permissions" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "type": "string", - "description": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n\\* `maintain` - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations. \n\\* `triage` - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", - "enum": [ - "pull", - "push", - "admin", - "maintain", - "triage" - ] - } - } - } - } - } - }, - "responses": { - "204": { - "description": "Empty response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - - ], - "category": "teams", - "subcategory": null - } - }, - "delete": { - "summary": "Remove a repository from a team", - "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", - "tags": [ - "teams" - ], - "operationId": "teams/remove-repo-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#remove-a-repository-from-a-team" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - } - ], - "responses": { - "204": { - "description": "Empty response" - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - - ], - "category": "teams", - "subcategory": null - } - } - }, - "/orgs/{org}/teams/{team_slug}/teams": { - "get": { - "summary": "List child teams", - "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", - "tags": [ - "teams" - ], - "operationId": "teams/list-child-in-org", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#list-child-teams" - }, - "parameters": [ - { - "name": "org", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "team_slug", - "description": "team_slug parameter", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "Response if child teams exist", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Team", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "slug": { - "type": "string" - }, - "description": { - "type": "string", - "nullable": true - }, - "privacy": { - "type": "string" - }, - "permission": { - "type": "string" - }, - "url": { - "type": "string", - "format": "uri" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" - }, - "members_url": { - "type": "string" - }, - "repositories_url": { - "type": "string", - "format": "uri" - }, - "parent": { - "nullable": true, - "allOf": [ - { - "title": "Team Simple", - "description": "Groups of organization members that gives permissions on specified repositories.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the team", - "type": "integer", - "example": 1 + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] }, - "node_id": { + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", - "example": "MDQ6VGVhbTE=" + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" }, "url": { - "description": "URL for the team", "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/1" + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "members_url": { + "archive_url": { "type": "string", - "example": "https://api.github.com/organizations/1/team/1/members{/member}" + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "name": { - "description": "Name of the team", + "assignees_url": { "type": "string", - "example": "Justice League" + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" }, - "description": { - "description": "Description of the team", + "blobs_url": { "type": "string", - "nullable": true, - "example": "A great team." + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" }, - "permission": { - "description": "Permission that the team will have for its repositories", + "branches_url": { "type": "string", - "example": "admin" + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" }, - "privacy": { - "description": "The level of privacy this team should have", + "collaborators_url": { "type": "string", - "example": "closed" + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" }, - "html_url": { + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { "type": "string", "format": "uri", - "example": "https://github.com/orgs/rails/teams/core" + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "repositories_url": { + "deployments_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/organizations/1/team/1/repos" + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "slug": { + "downloads_url": { "type": "string", - "example": "justice-league" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, - "ldap_dn": { - "description": "Distinguished Name (DN) that team maps to within LDAP environment", - "example": "uid=example,ou=users,dc=github,dc=com", - "type": "string" - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ], - "nullable": true - } - ] - } - }, - "required": [ - "id", - "node_id", - "url", - "members_url", - "name", - "description", - "permission", - "html_url", - "repositories_url", - "slug" - ] - } - }, - "examples": { - "response-if-child-teams-exist": { - "value": [ - { - "id": 2, - "node_id": "MDQ6VGVhbTI=", - "url": "https://api.github.com/teams/2", - "name": "Original Roster", - "slug": "original-roster", - "description": "Started it all.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/2/members{/member}", - "repositories_url": "https://api.github.com/teams/2/repos", - "parent": { - "id": 1, - "node_id": "MDQ6VGVhbTE=", - "url": "https://api.github.com/teams/1", - "html_url": "https://github.com/orgs/github/teams/justice-league", - "name": "Justice League", - "slug": "justice-league", - "description": "A great team.", - "privacy": "closed", - "permission": "admin", - "members_url": "https://api.github.com/teams/1/members{/member}", - "repositories_url": "https://api.github.com/teams/1/repos" - }, - "html_url": "https://github.com/orgs/rails/teams/core" - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - - ], - "category": "teams", - "subcategory": null - } - } - }, - "/projects/columns/cards/{card_id}": { - "get": { - "summary": "Get a project card", - "description": "", - "tags": [ - "projects" - ], - "operationId": "projects/get-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#get-a-project-card" - }, - "parameters": [ - { - "name": "card_id", - "description": "card_id parameter", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" - }, - "id": { - "description": "The project card's ID", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" - }, - "note": { - "type": "string", - "example": "Add payload for delete Project column", - "nullable": true - }, - "creator": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:21:06Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:20:22Z" - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "content_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + } }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + } }, "examples": { "default": { - "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - } - } - } - } - }, - "304": { - "description": "Not Modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires Authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource Not Found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" - } - ], - "category": "projects", - "subcategory": "cards" + "value": [ + { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + } + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "teams", + "subcategory": null } - }, - "patch": { - "summary": "Update an existing project card", - "description": "", + } + }, + "/orgs/{org}/teams/{team_slug}/repos/{owner}/{repo}": { + "get": { + "summary": "Check team permissions for a repository", + "description": "Checks whether a team has `admin`, `push`, `maintain`, `triage`, or `pull` permission for a repository. Repositories inherited through a parent team will also be checked.\n\nYou can also get information about the specified repository, including what permissions the team grants on it, by passing the following custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types/) via the `application/vnd.github.v3.repository+json` accept header.\n\nIf a team doesn't have permission for the repository, you will receive a `404 Not Found` response status.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", "tags": [ - "projects" + "teams" ], - "operationId": "projects/update-card", + "operationId": "teams/check-permissions-for-repo-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#update-a-project-card" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#check-team-permissions-for-a-repository" }, "parameters": [ { - "name": "card_id", - "description": "card_id parameter", + "name": "org", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "note": { - "description": "The project card's note", - "example": "Update all gems", - "type": "string", - "nullable": true - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - } - } - } + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" } } - }, + ], "responses": { "200": { - "description": "response", + "description": "Alternative response with repository permissions", "content": { - "application/json": { + "application/vnd.github.v3.repository+json": { "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", + "title": "Team Repository", + "description": "A team's access to a repository.", "type": "object", "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" - }, "id": { - "description": "The project card's ID", + "description": "Unique identifier of the repository", "example": 42, "type": "integer" }, "node_id": { "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "note": { + "name": { + "description": "The name of the repository.", "type": "string", - "example": "Add payload for delete Project column", - "nullable": true + "example": "Team Environment" }, - "creator": { + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { "nullable": true, "allOf": [ { @@ -61530,2225 +65271,1410 @@ } ] }, - "created_at": { + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:21:06Z" + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "updated_at": { + "description": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:20:22Z" + "example": "This your first repo!", + "nullable": true }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, + "fork": { "type": "boolean" }, - "column_url": { + "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367" + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "content_url": { + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "project_url": { + "deployments_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/120" - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - } - } - } - } - }, - "304": { - "description": "Not Modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires Authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource Not Found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - "documentation_url": { - "type": "string" + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" - } - ], - "category": "projects", - "subcategory": "cards" - } - }, - "delete": { - "summary": "Delete a project card", - "description": "", - "tags": [ - "projects" - ], - "operationId": "projects/delete-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#delete-a-project-card" - }, - "parameters": [ - { - "name": "card_id", - "description": "card_id parameter", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Empty response" - }, - "304": { - "description": "Not Modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - "documentation_url": { - "type": "string" + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "401": { - "description": "Requires Authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource Not Found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" - } - ], - "category": "projects", - "subcategory": "cards" - } - } - }, - "/projects/columns/cards/{card_id}/moves": { - "post": { - "summary": "Move a project card", - "description": "", - "tags": [ - "projects" - ], - "operationId": "projects/move-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#move-a-project-card" - }, - "parameters": [ - { - "name": "card_id", - "description": "card_id parameter", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the card in a column", - "example": "bottom", - "type": "string", - "pattern": "^(?:top|bottom|after:\\d+)$" - }, - "column_id": { - "description": "The unique identifier of the column the card should be moved to", - "example": 42, - "type": "integer" - } - }, - "required": [ - "position" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - }, - "additionalProperties": false - } - } - } - }, - "304": { - "description": "Not Modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "message": { - "type": "string" + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, - "documentation_url": { - "type": "string" + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "resource": { - "type": "string" - }, - "field": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "401": { - "description": "Requires Authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "503": { - "description": "Service Unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" }, - "message": { - "type": "string" + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, - "documentation_url": { - "type": "string" + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - } - } - } - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" }, - "documentation_url": { - "type": "string" + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" - } - ], - "category": "projects", - "subcategory": "cards" - } - } - }, - "/projects/columns/{column_id}": { - "get": { - "summary": "Get a project column", - "description": "", - "tags": [ - "projects" - ], - "operationId": "projects/get-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#get-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "column_id parameter", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { + "pulls_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" }, - "project_url": { + "releases_url": { "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, - "cards_url": { + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, - "node_id": { + "subscribers_url": { "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, - "created_at": { + "tags_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, - "updated_at": { + "teams_url": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:22:28Z" - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - } - } - } - } - }, - "304": { - "description": "Not Modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "404": { - "description": "Resource Not Found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires Authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" - } - ], - "category": "projects", - "subcategory": "columns" - } - }, - "patch": { - "summary": "Update an existing project column", - "description": "", - "tags": [ - "projects" - ], - "operationId": "projects/update-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#update-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "column_id parameter", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" - } - }, - "required": [ - "name" - ], - "type": "object" - } - } - } - }, - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", - "type": "object", - "properties": { - "url": { + "mirror_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367" + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true }, - "project_url": { + "hooks_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/120" + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, - "cards_url": { + "svn_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" + "example": "https://svn.github.com/octocat/Hello-World" }, - "id": { - "description": "The unique identifier of the project column", - "example": 42, - "type": "integer" + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true }, - "node_id": { + "language": { "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "nullable": true }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" + "forks_count": { + "type": "integer", + "example": 9 }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" + "stargazers_count": { + "type": "integer", + "example": 80 }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:22:28Z" - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" - } - } - } - } - } - }, - "304": { - "description": "Not Modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "watchers_count": { + "type": "integer", + "example": 80 }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires Authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "size": { + "type": "integer", + "example": 108 }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" - } - ], - "category": "projects", - "subcategory": "columns" - } - }, - "delete": { - "summary": "Delete a project column", - "description": "", - "tags": [ - "projects" - ], - "operationId": "projects/delete-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#delete-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "column_id parameter", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "204": { - "description": "Empty response" - }, - "304": { - "description": "Not Modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires Authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "open_issues_count": { + "type": "integer", + "example": 0 }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" - } - ], - "category": "projects", - "subcategory": "columns" - } - } - }, - "/projects/columns/{column_id}/cards": { - "get": { - "summary": "List project cards", - "description": "", - "tags": [ - "projects" - ], - "operationId": "projects/list-cards", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#list-project-cards" - }, - "parameters": [ - { - "name": "column_id", - "description": "column_id parameter", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "archived_state", - "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "all", - "archived", - "not_archived" - ], - "default": "not_archived" - } - }, - { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "array", - "items": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" - }, - "id": { - "description": "The project card's ID", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" - }, - "note": { - "type": "string", - "example": "Add payload for delete Project column", - "nullable": true - }, - "creator": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:21:06Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:20:22Z" - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "content_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - } + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" + "topics": { + "type": "array", + "items": { + "type": "string" } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "304": { - "description": "Not Modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires Authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" - } - ], - "category": "projects", - "subcategory": "cards" - } - }, - "post": { - "summary": "Create a project card", - "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests)\" endpoint.", - "tags": [ - "projects" - ], - "operationId": "projects/create-card", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#create-a-project-card" - }, - "parameters": [ - { - "name": "column_id", - "description": "column_id parameter", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "type": "object", - "properties": { - "note": { - "description": "The project card's note", - "example": "Update all gems", - "type": "string", - "nullable": true - } + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true }, - "required": [ - "note" - ] - }, - { - "type": "object", - "properties": { - "content_id": { - "description": "The unique identifier of the content associated with the card", - "example": 42, - "type": "integer" - }, - "content_type": { - "description": "The piece of content associated with the card", - "example": "PullRequest", - "type": "string" - } + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true }, - "required": [ - "content_id", - "content_type" - ] - } - ] - } - } - } - }, - "responses": { - "201": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "Project Card", - "description": "Project cards represent a scope of work.", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/cards/1478" + "has_pages": { + "type": "boolean" }, - "id": { - "description": "The project card's ID", - "example": 42, - "type": "integer" + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true }, - "node_id": { + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { "type": "string", - "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true }, - "note": { + "created_at": { "type": "string", - "example": "Add payload for delete Project column", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", "nullable": true }, - "creator": { + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "type": "object", "nullable": true, "allOf": [ { - "title": "Simple User", - "description": "Simple User", + "title": "Repository", + "description": "A git repository", "type": "object", "properties": { - "login": { - "type": "string", - "example": "octocat" - }, "id": { - "type": "integer", - "example": 1 + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" }, "node_id": { "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "gravatar_id": { + "name": { + "description": "The name of the repository.", "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "Team Environment" }, - "url": { + "full_name": { "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "octocat/Hello-World" }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] }, - "followers_url": { + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "https://github.com/octocat/Hello-World" }, - "following_url": { + "description": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "example": "This your first repo!", + "nullable": true }, - "gists_url": { + "fork": { + "type": "boolean" + }, + "url": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" }, - "starred_url": { + "archive_url": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" }, - "subscriptions_url": { + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" }, - "organizations_url": { + "deployments_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" }, - "repos_url": { + "downloads_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" }, "events_url": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" }, - "received_events_url": { + "forks_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "example": "http://api.github.com/repos/octocat/Hello-World/forks" }, - "type": { + "git_commits_url": { "type": "string", - "example": "User" + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" }, - "site_admin": { - "type": "boolean" + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" }, - "starred_at": { + "git_tags_url": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:21:06Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:20:22Z" - }, - "archived": { - "description": "Whether or not the card is archived", - "example": false, - "type": "boolean" - }, - "column_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "content_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - } - }, - "required": [ - "id", - "node_id", - "note", - "url", - "column_url", - "project_url", - "creator", - "created_at", - "updated_at" - ] - }, - "examples": { - "default": { - "value": { - "url": "https://api.github.com/projects/columns/cards/1478", - "id": 1478, - "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", - "note": "Add payload for delete Project column", - "creator": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "created_at": "2016-09-05T14:21:06Z", - "updated_at": "2016-09-05T14:20:22Z", - "archived": false, - "column_url": "https://api.github.com/projects/columns/367", - "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", - "project_url": "https://api.github.com/projects/120" - } - } - } - } - } - }, - "304": { - "description": "Not Modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires Authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "oneOf": [ - { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - }, - { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - ] - } - } - } - }, - "503": { - "description": "Service Unavailable", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "properties": { - "code": { - "type": "string" - }, - "message": { - "type": "string" - } - } - } - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" - } - ], - "category": "projects", - "subcategory": "cards" - } - } - }, - "/projects/columns/{column_id}/moves": { - "post": { - "summary": "Move a project column", - "description": "", - "tags": [ - "projects" - ], - "operationId": "projects/move-column", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#move-a-project-column" - }, - "parameters": [ - { - "name": "column_id", - "description": "column_id parameter", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "properties": { - "position": { - "description": "The position of the column in a project", - "example": "last", - "type": "string", - "pattern": "^(?:first|last|after:\\d+)$" - } - }, - "required": [ - "position" - ], - "type": "object" - } - } - } - }, - "responses": { - "201": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - }, - "additionalProperties": false - } - } - } - }, - "304": { - "description": "Not Modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, - "401": { - "description": "Requires Authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" - } - ], - "category": "projects", - "subcategory": "columns" - } - } - }, - "/projects/{project_id}": { - "get": { - "summary": "Get a project", - "description": "Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "tags": [ - "projects" - ], - "operationId": "projects/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects/#get-a-project" - }, - "parameters": [ - { - "name": "project_id", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - } - ], - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { "type": "string", - "example": "octocat" + "example": "git:github.com/octocat/Hello-World.git" }, - "id": { - "type": "integer", - "example": 1 + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" }, - "node_id": { + "issue_events_url": { "type": "string", - "example": "MDQ6VXNlcjE=" + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" }, - "avatar_url": { + "issues_url": { "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" }, - "gravatar_id": { + "keys_url": { "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" }, - "url": { + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat" + "example": "http://api.github.com/repos/octocat/Hello-World/languages" }, - "html_url": { + "merges_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat" + "example": "http://api.github.com/repos/octocat/Hello-World/merges" }, - "followers_url": { + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/followers" + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" }, - "following_url": { + "statuses_url": { "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" }, - "gists_url": { + "subscribers_url": { "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" }, - "starred_url": { + "subscription_url": { "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" }, - "subscriptions_url": { + "tags_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" + "example": "http://api.github.com/repos/octocat/Hello-World/tags" }, - "organizations_url": { + "teams_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" + "example": "http://api.github.com/repos/octocat/Hello-World/teams" }, - "repos_url": { + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/repos" + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true }, - "events_url": { + "hooks_url": { "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, - "received_events_url": { + "svn_url": { "type": "string", "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" + "example": "https://svn.github.com/octocat/Hello-World" }, - "type": { + "homepage": { "type": "string", - "example": "User" + "format": "uri", + "example": "https://github.com", + "nullable": true }, - "site_admin": { + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { "type": "boolean" }, - "starred_at": { + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] } ] }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-04-10T20:09:31Z" + "temp_clone_token": { + "type": "string" }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2014-03-03T18:58:10Z" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", - "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" } }, "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", "id", "node_id", - "number", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", "name", - "body", - "state", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", "url", - "html_url", - "owner_url", - "creator", - "columns_url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", "created_at", "updated_at" ] }, "examples": { - "default": { + "alternative-response-with-repository-permissions": { "value": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", - "creator": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -63768,90 +66694,288 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 } } } } } }, - "304": { - "description": "Not Modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } + "204": { + "description": "Response if team has permission for the repository" }, - "401": { - "description": "Requires Authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } + "404": { + "description": "Response if team does not have permission for the repository" } }, "x-github": { "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" - } + ], - "category": "projects", + "category": "teams", "subcategory": null } }, - "patch": { - "summary": "Update a project", - "description": "Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", - "operationId": "projects/update", + "put": { + "summary": "Add or update team repository permissions", + "description": "To add a repository to a team or update the team's permission on a repository, the authenticated user must have admin access to the repository, and must be able to see the team. The repository must be owned by the organization, or a direct fork of a repository owned by the organization. You will get a `422 Unprocessable Entity` status if you attempt to add a repository to a team that is not owned by the organization. Note that, if you choose not to pass any parameters, you'll need to set `Content-Length` to zero when calling out to this endpoint. For more information, see \"[HTTP verbs](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#http-verbs).\"\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `PUT /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.\n\nFor more information about the permission levels, see \"[Repository permission levels for an organization](https://help.github.com/en/github/setting-up-and-managing-organizations-and-teams/repository-permission-levels-for-an-organization#permission-levels-for-repositories-owned-by-an-organization)\".", "tags": [ - "projects" + "teams" ], + "operationId": "teams/add-or-update-repo-permissions-in-org", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects/#update-a-project" + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#add-or-update-team-repository-permissions" }, "parameters": [ { - "name": "project_id", + "name": "org", "in": "path", "required": true, "schema": { - "type": "integer" + "type": "string" + } + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" } } ], @@ -63859,117 +66983,422 @@ "content": { "application/json": { "schema": { + "type": "object", "properties": { - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project", + "permission": { "type": "string", + "description": "The permission to grant the team on this repository. Can be one of: \n\\* `pull` - team members can pull, but not push to or administer this repository. \n\\* `push` - team members can pull and push, but not administer this repository. \n\\* `admin` - team members can pull, push and administer this repository. \n\\* `maintain` - team members can manage the repository without access to sensitive or destructive actions. Recommended for project managers. Only applies to repositories owned by organizations. \n\\* `triage` - team members can proactively manage issues and pull requests without write access. Recommended for contributors who triage a repository. Only applies to repositories owned by organizations. \n \nIf no permission is specified, the team's `permission` attribute will be used to determine what permission to grant the team on this repository.", "enum": [ - "read", - "write", + "pull", + "push", "admin", - "none" + "maintain", + "triage" ] - }, - "private": { - "description": "Whether or not this project can be seen by everyone.", - "type": "boolean" } - }, - "type": "object" + } } } } }, "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "Project", - "description": "Projects are a way to organize columns and cards of work.", - "type": "object", - "properties": { - "owner_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/api-playground/projects-test" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/api-playground/projects-test/projects/12" - }, - "columns_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/1002604/columns" - }, - "id": { - "type": "integer", - "example": 1002604 - }, - "node_id": { - "type": "string", - "example": "MDc6UHJvamVjdDEwMDI2MDQ=" - }, - "name": { - "description": "Name of the project", - "example": "Week One Sprint", - "type": "string" - }, - "body": { - "description": "Body of the project", - "example": "This project represents the sprint of the first week in January", - "type": "string", - "nullable": true - }, - "number": { - "type": "integer", - "example": 1 - }, - "state": { - "description": "State of the project; either 'open' or 'closed'", - "example": "open", - "type": "string" - }, - "creator": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, + "204": { + "description": "Empty response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "teams", + "subcategory": null + } + }, + "delete": { + "summary": "Remove a repository from a team", + "description": "If the authenticated user is an organization owner or a team maintainer, they can remove any repositories from the team. To remove a repository from a team as an organization member, the authenticated user must have admin access to the repository and must be able to see the team. This does not delete the repository, it just removes it from the team.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `DELETE /organizations/{org_id}/team/{team_id}/repos/{owner}/{repo}`.", + "tags": [ + "teams" + ], + "operationId": "teams/remove-repo-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#remove-a-repository-from-a-team" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "teams", + "subcategory": null + } + } + }, + "/orgs/{org}/teams/{team_slug}/teams": { + "get": { + "summary": "List child teams", + "description": "Lists the child teams of the team specified by `{team_slug}`.\n\n**Note:** You can also specify a team by `org_id` and `team_id` using the route `GET /organizations/{org_id}/team/{team_id}/teams`.", + "tags": [ + "teams" + ], + "operationId": "teams/list-child-in-org", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/teams/#list-child-teams" + }, + "parameters": [ + { + "name": "org", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "team_slug", + "description": "team_slug parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "Response if child teams exist", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Team", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "slug": { + "type": "string" + }, + "description": { + "type": "string", + "nullable": true + }, + "privacy": { + "type": "string" + }, + "permission": { + "type": "string" + }, + "url": { + "type": "string", + "format": "uri" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "members_url": { + "type": "string" + }, + "repositories_url": { + "type": "string", + "format": "uri" + }, + "parent": { + "nullable": true, + "allOf": [ + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + ] + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ] + } + }, + "examples": { + "response-if-child-teams-exist": { + "value": [ + { + "id": 2, + "node_id": "MDQ6VGVhbTI=", + "url": "https://api.github.com/teams/2", + "name": "Original Roster", + "slug": "original-roster", + "description": "Started it all.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/2/members{/member}", + "repositories_url": "https://api.github.com/teams/2/repos", + "parent": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos" + }, + "html_url": "https://github.com/orgs/rails/teams/core" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "teams", + "subcategory": null + } + } + }, + "/projects/columns/cards/{card_id}": { + "get": { + "summary": "Get a project card", + "description": "", + "tags": [ + "projects" + ], + "operationId": "projects/get-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#get-a-project-card" + }, + "parameters": [ + { + "name": "card_id", + "description": "card_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Project Card", + "description": "Project cards represent a scope of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/columns/cards/1478" + }, + "id": { + "description": "The project card's ID", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" + }, + "note": { + "type": "string", + "example": "Add payload for delete Project column", + "nullable": true + }, + "creator": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, "node_id": { "type": "string", "example": "MDQ6VXNlcjE=" @@ -64074,40 +67503,42 @@ "created_at": { "type": "string", "format": "date-time", - "example": "2011-04-10T20:09:31Z" + "example": "2016-09-05T14:21:06Z" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2014-03-03T18:58:10Z" + "example": "2016-09-05T14:20:22Z" }, - "organization_permission": { - "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "archived": { + "description": "Whether or not the card is archived", + "example": false, + "type": "boolean" + }, + "column_url": { "type": "string", - "enum": [ - "read", - "write", - "admin", - "none" - ] + "format": "uri", + "example": "https://api.github.com/projects/columns/367" }, - "private": { - "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", - "type": "boolean" + "content_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" + }, + "project_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/120" } }, "required": [ "id", "node_id", - "number", - "name", - "body", - "state", + "note", "url", - "html_url", - "owner_url", + "column_url", + "project_url", "creator", - "columns_url", "created_at", "updated_at" ] @@ -64115,16 +67546,10 @@ "examples": { "default": { "value": { - "owner_url": "https://api.github.com/repos/api-playground/projects-test", - "url": "https://api.github.com/projects/1002604", - "html_url": "https://github.com/api-playground/projects-test/projects/1", - "columns_url": "https://api.github.com/projects/1002604/columns", - "id": 1002604, - "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", - "name": "Projects Documentation", - "body": "Developer documentation project for the developer site.", - "number": 1, - "state": "open", + "url": "https://api.github.com/projects/columns/cards/1478", + "id": 1478, + "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", + "note": "Add payload for delete Project column", "creator": { "login": "octocat", "id": 1, @@ -64145,8 +67570,55 @@ "type": "User", "site_admin": false }, - "created_at": "2011-04-10T20:09:31Z", - "updated_at": "2014-03-03T18:58:10Z" + "created_at": "2016-09-05T14:21:06Z", + "updated_at": "2016-09-05T14:20:22Z", + "archived": false, + "column_url": "https://api.github.com/projects/columns/367", + "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", + "project_url": "https://api.github.com/projects/120" + } + } + } + } + } + }, + "304": { + "description": "Not Modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires Authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" } } } @@ -64154,7 +67626,311 @@ } }, "404": { - "description": "Response if the authenticated user does not have access to the project" + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "cards" + } + }, + "patch": { + "summary": "Update an existing project card", + "description": "", + "tags": [ + "projects" + ], + "operationId": "projects/update-card", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#update-a-project-card" + }, + "parameters": [ + { + "name": "card_id", + "description": "card_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "note": { + "description": "The project card's note", + "example": "Update all gems", + "type": "string", + "nullable": true + }, + "archived": { + "description": "Whether or not the card is archived", + "example": false, + "type": "boolean" + } + } + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Project Card", + "description": "Project cards represent a scope of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/columns/cards/1478" + }, + "id": { + "description": "The project card's ID", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" + }, + "note": { + "type": "string", + "example": "Add payload for delete Project column", + "nullable": true + }, + "creator": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-09-05T14:21:06Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2016-09-05T14:20:22Z" + }, + "archived": { + "description": "Whether or not the card is archived", + "example": false, + "type": "boolean" + }, + "column_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/columns/367" + }, + "content_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" + }, + "project_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/120" + } + }, + "required": [ + "id", + "node_id", + "note", + "url", + "column_url", + "project_url", + "creator", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/projects/columns/cards/1478", + "id": 1478, + "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", + "note": "Add payload for delete Project column", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2016-09-05T14:21:06Z", + "updated_at": "2016-09-05T14:20:22Z", + "archived": false, + "column_url": "https://api.github.com/projects/columns/367", + "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", + "project_url": "https://api.github.com/projects/120" + } + } + } + } + } }, "304": { "description": "Not Modified" @@ -64164,6 +67940,8 @@ "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", "properties": { "message": { @@ -64171,12 +67949,6 @@ }, "documentation_url": { "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } } } } @@ -64203,8 +67975,8 @@ } } }, - "410": { - "description": "Gone", + "404": { + "description": "Resource Not Found", "content": { "application/json": { "schema": { @@ -64265,23 +68037,24 @@ } ], "category": "projects", - "subcategory": null + "subcategory": "cards" } }, "delete": { - "summary": "Delete a project", - "description": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled.", - "operationId": "projects/delete", + "summary": "Delete a project card", + "description": "", "tags": [ "projects" ], + "operationId": "projects/delete-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects/#delete-a-project" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#delete-a-project-card" }, "parameters": [ { - "name": "project_id", + "name": "card_id", + "description": "card_id parameter", "in": "path", "required": true, "schema": { @@ -64291,7 +68064,7 @@ ], "responses": { "204": { - "description": "Delete Success" + "description": "Empty response" }, "304": { "description": "Not Modified" @@ -64340,26 +68113,6 @@ } } }, - "410": { - "description": "Gone", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, "404": { "description": "Resource Not Found", "content": { @@ -64392,258 +68145,162 @@ } ], "category": "projects", - "subcategory": null + "subcategory": "cards" } } }, - "/projects/{project_id}/collaborators": { - "get": { - "summary": "List project collaborators", - "description": "Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators.", + "/projects/columns/cards/{card_id}/moves": { + "post": { + "summary": "Move a project card", + "description": "", "tags": [ "projects" ], - "operationId": "projects/list-collaborators", + "operationId": "projects/move-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#list-project-collaborators" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#move-a-project-card" }, "parameters": [ { - "name": "project_id", + "name": "card_id", + "description": "card_id parameter", "in": "path", "required": true, "schema": { "type": "integer" } - }, - { - "name": "affiliation", - "description": "Filters the collaborators by their affiliation. Can be one of: \n\\* `outside`: Outside collaborators of a project that are not a member of the project's organization. \n\\* `direct`: Collaborators with permissions to a project, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "outside", - "direct", - "all" - ], - "default": "all" + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "position": { + "description": "The position of the card in a column", + "example": "bottom", + "type": "string", + "pattern": "^(?:top|bottom|after:\\d+)$" + }, + "column_id": { + "description": "The unique identifier of the column the card should be moved to", + "example": 42, + "type": "integer" + } + }, + "required": [ + "position" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + }, + "additionalProperties": false + } + } } }, - { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", - "schema": { - "type": "integer", - "default": 30 + "304": { + "description": "Not Modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "resource": { + "type": "string" + }, + "field": { + "type": "string" + } + } + } + } + } + } + } } }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", - "schema": { - "type": "integer", - "default": 1 + "401": { + "description": "Requires Authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } } - } - ], - "responses": { - "200": { - "description": "response", + }, + "503": { + "description": "Service Unavailable", "content": { "application/json": { "schema": { - "type": "array", - "items": { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - }, - "examples": { - "default": { - "value": [ - { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - ] - } - } - } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", - "schema": { - "type": "string" - } - } - } - }, - "404": { - "description": "Resource Not Found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { + "code": { "type": "string" }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "415": { - "description": "Preview Header Missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + } } } } @@ -64718,49 +68375,6 @@ } } } - }, - "304": { - "description": "Not Modified" - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "401": { - "description": "Requires Authentication", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } } }, "x-github": { @@ -64774,182 +68388,136 @@ } ], "category": "projects", - "subcategory": "collaborators" + "subcategory": "cards" } } }, - "/projects/{project_id}/collaborators/{username}": { - "put": { - "summary": "Add project collaborator", - "description": "Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.", + "/projects/columns/{column_id}": { + "get": { + "summary": "Get a project column", + "description": "", "tags": [ "projects" ], - "operationId": "projects/add-collaborator", + "operationId": "projects/get-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#add-project-collaborator" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#get-a-project-column" }, "parameters": [ { - "name": "project_id", + "name": "column_id", + "description": "column_id parameter", "in": "path", "required": true, "schema": { "type": "integer" } - }, - { - "name": "username", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "permission": { - "description": "The permission to grant the collaborator.", - "enum": [ - "read", - "write", - "admin" - ], - "default": "write", - "example": "write", - "type": "string" - } - } - } - } - } - }, "responses": { - "204": { - "description": "Empty response" - }, - "404": { - "description": "Resource Not Found", + "200": { + "description": "response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Project Column", + "description": "Project columns contain cards of work.", "type": "object", "properties": { - "message": { - "type": "string" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/columns/367" }, - "documentation_url": { + "project_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/120" + }, + "cards_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/columns/367/cards" + }, + "id": { + "description": "The unique identifier of the project column", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" + }, + "name": { + "description": "Name of the project column", + "example": "Remaining tasks", "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-09-05T14:18:44Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2016-09-05T14:22:28Z" } - } - } - } - } - }, - "415": { - "description": "Preview Header Missing", - "content": { - "application/json": { - "schema": { - "type": "object", + }, "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" } } } } } }, - "422": { - "description": "Validation Failed", + "304": { + "description": "Not Modified" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { - "title": "Validation Error", - "description": "Validation Error", + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } } } } } } }, - "304": { - "description": "Not Modified" - }, - "403": { - "description": "Forbidden", + "404": { + "description": "Resource Not Found", "content": { "application/json": { "schema": { @@ -65000,87 +68568,131 @@ } ], "category": "projects", - "subcategory": "collaborators" + "subcategory": "columns" } }, - "delete": { - "summary": "Remove user as a collaborator", - "description": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.", + "patch": { + "summary": "Update an existing project column", + "description": "", "tags": [ "projects" ], - "operationId": "projects/remove-collaborator", + "operationId": "projects/update-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#remove-project-collaborator" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#update-a-project-column" }, "parameters": [ { - "name": "project_id", + "name": "column_id", + "description": "column_id parameter", "in": "path", "required": true, "schema": { "type": "integer" } - }, - { - "name": "username", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], - "responses": { - "204": { - "description": "Empty response" - }, - "304": { - "description": "Not Modified" - }, - "404": { - "description": "Resource Not Found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "Name of the project column", + "example": "Remaining tasks", + "type": "string" } - } + }, + "required": [ + "name" + ], + "type": "object" } } - }, - "415": { - "description": "Preview Header Missing", + } + }, + "responses": { + "200": { + "description": "response", "content": { "application/json": { "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { - "message": { - "type": "string" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/columns/367" }, - "documentation_url": { + "project_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/120" + }, + "cards_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/columns/367/cards" + }, + "id": { + "description": "The unique identifier of the project column", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" + }, + "name": { + "description": "Name of the project column", + "example": "Remaining tasks", "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-09-05T14:18:44Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2016-09-05T14:22:28Z" + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" } } } } } }, + "304": { + "description": "Not Modified" + }, "403": { "description": "Forbidden", "content": { @@ -65101,75 +68713,6 @@ } } }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } - }, "401": { "description": "Requires Authentication", "content": { @@ -65202,316 +68745,34 @@ } ], "category": "projects", - "subcategory": "collaborators" + "subcategory": "columns" } - } - }, - "/projects/{project_id}/collaborators/{username}/permission": { - "get": { - "summary": "Get project permission for a user", - "description": "Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.", + }, + "delete": { + "summary": "Delete a project column", + "description": "", "tags": [ "projects" ], - "operationId": "projects/get-permission-for-user", + "operationId": "projects/delete-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#get-project-permission-for-a-user" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#delete-a-project-column" }, "parameters": [ { - "name": "project_id", + "name": "column_id", + "description": "column_id parameter", "in": "path", "required": true, "schema": { "type": "integer" } - }, - { - "name": "username", - "in": "path", - "required": true, - "schema": { - "type": "string" - } } ], "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "title": "Repository Collaborator Permission", - "description": "Repository Collaborator Permission", - "type": "object", - "properties": { - "permission": { - "type": "string" - }, - "user": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - } - }, - "required": [ - "permission", - "user" - ] - }, - "examples": { - "default": { - "value": { - "permission": "admin", - "user": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - } - } - } - } - } - } - }, - "404": { - "description": "Resource Not Found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "415": { - "description": "Preview Header Missing", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" - }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] - } - } - } - } - } - } - } - } + "204": { + "description": "Empty response" }, "304": { "description": "Not Modified" @@ -65568,31 +68829,47 @@ } ], "category": "projects", - "subcategory": "collaborators" + "subcategory": "columns" } } }, - "/projects/{project_id}/columns": { + "/projects/columns/{column_id}/cards": { "get": { - "summary": "List project columns", + "summary": "List project cards", "description": "", "tags": [ "projects" ], - "operationId": "projects/list-columns", + "operationId": "projects/list-cards", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#list-project-columns" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#list-project-cards" }, "parameters": [ { - "name": "project_id", + "name": "column_id", + "description": "column_id parameter", "in": "path", "required": true, "schema": { "type": "integer" } }, + { + "name": "archived_state", + "description": "Filters the project cards that are returned by the card's state. Can be one of `all`,`archived`, or `not_archived`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "all", + "archived", + "not_archived" + ], + "default": "not_archived" + } + }, { "name": "per_page", "description": "Results per page (max 100).", @@ -65620,74 +68897,224 @@ "schema": { "type": "array", "items": { - "title": "Project Column", - "description": "Project columns contain cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - }, - "cards_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" + "example": "https://api.github.com/projects/columns/cards/1478" }, "id": { - "description": "The unique identifier of the project column", + "description": "The project card's ID", "example": 42, "type": "integer" }, "node_id": { "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" - }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" + "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" }, - "created_at": { + "note": { "type": "string", - "format": "date-time", - "example": "2016-09-05T14:18:44Z" + "example": "Add payload for delete Project column", + "nullable": true }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2016-09-05T14:22:28Z" - } - }, - "required": [ - "id", - "node_id", - "url", - "project_url", - "cards_url", - "name", - "created_at", - "updated_at" - ] - } - }, - "examples": { - "default": { - "value": [ - { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" + "creator": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-09-05T14:21:06Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2016-09-05T14:20:22Z" + }, + "archived": { + "description": "Whether or not the card is archived", + "example": false, + "type": "boolean" + }, + "column_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/columns/367" + }, + "content_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" + }, + "project_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/120" + } + }, + "required": [ + "id", + "node_id", + "note", + "url", + "column_url", + "project_url", + "creator", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "url": "https://api.github.com/projects/columns/cards/1478", + "id": 1478, + "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", + "note": "Add payload for delete Project column", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2016-09-05T14:21:06Z", + "updated_at": "2016-09-05T14:20:22Z", + "archived": false, + "column_url": "https://api.github.com/projects/columns/367", + "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", + "project_url": "https://api.github.com/projects/120" } ] } @@ -65758,23 +69185,24 @@ } ], "category": "projects", - "subcategory": "columns" + "subcategory": "cards" } }, "post": { - "summary": "Create a project column", - "description": "", + "summary": "Create a project card", + "description": "**Note**: GitHub's REST API v3 considers every pull request an issue, but not every issue is a pull request. For this reason, \"Issues\" endpoints may return both issues and pull requests in the response. You can identify pull requests by the `pull_request` key.\n\nBe aware that the `id` of a pull request returned from \"Issues\" endpoints will be an _issue id_. To find out the pull request id, use the \"[List pull requests](https://docs.github.com/github-ae@latest/rest/reference/pulls#list-pull-requests)\" endpoint.", "tags": [ "projects" ], - "operationId": "projects/create-column", + "operationId": "projects/create-card", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#create-a-project-column" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#create-a-project-card" }, "parameters": [ { - "name": "project_id", + "name": "column_id", + "description": "column_id parameter", "in": "path", "required": true, "schema": { @@ -65786,17 +69214,41 @@ "content": { "application/json": { "schema": { - "properties": { - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" + "oneOf": [ + { + "type": "object", + "properties": { + "note": { + "description": "The project card's note", + "example": "Update all gems", + "type": "string", + "nullable": true + } + }, + "required": [ + "note" + ] + }, + { + "type": "object", + "properties": { + "content_id": { + "description": "The unique identifier of the content associated with the card", + "example": 42, + "type": "integer" + }, + "content_type": { + "description": "The piece of content associated with the card", + "example": "PullRequest", + "type": "string" + } + }, + "required": [ + "content_id", + "content_type" + ] } - }, - "required": [ - "name" - ], - "type": "object" + ] } } } @@ -65807,70 +69259,224 @@ "content": { "application/json": { "schema": { - "title": "Project Column", - "description": "Project columns contain cards of work.", + "title": "Project Card", + "description": "Project cards represent a scope of work.", "type": "object", "properties": { "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/projects/columns/367" - }, - "project_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/120" - }, - "cards_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/projects/columns/367/cards" + "example": "https://api.github.com/projects/columns/cards/1478" }, "id": { - "description": "The unique identifier of the project column", + "description": "The project card's ID", "example": 42, "type": "integer" }, "node_id": { "type": "string", - "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" + "example": "MDExOlByb2plY3RDYXJkMTQ3OA==" }, - "name": { - "description": "Name of the project column", - "example": "Remaining tasks", - "type": "string" + "note": { + "type": "string", + "example": "Add payload for delete Project column", + "nullable": true + }, + "creator": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] }, "created_at": { "type": "string", "format": "date-time", - "example": "2016-09-05T14:18:44Z" + "example": "2016-09-05T14:21:06Z" }, "updated_at": { "type": "string", "format": "date-time", - "example": "2016-09-05T14:22:28Z" + "example": "2016-09-05T14:20:22Z" + }, + "archived": { + "description": "Whether or not the card is archived", + "example": false, + "type": "boolean" + }, + "column_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/columns/367" + }, + "content_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/api-playground/projects-test/issues/3" + }, + "project_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/120" } }, "required": [ "id", "node_id", + "note", "url", + "column_url", "project_url", - "cards_url", - "name", + "creator", "created_at", "updated_at" ] }, - "example": { - "url": "https://api.github.com/projects/columns/367", - "project_url": "https://api.github.com/projects/120", - "cards_url": "https://api.github.com/projects/columns/367/cards", - "id": 367, - "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", - "name": "To Do", - "created_at": "2016-09-05T14:18:44Z", - "updated_at": "2016-09-05T14:22:28Z" + "examples": { + "default": { + "value": { + "url": "https://api.github.com/projects/columns/cards/1478", + "id": 1478, + "node_id": "MDExOlByb2plY3RDYXJkMTQ3OA==", + "note": "Add payload for delete Project column", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2016-09-05T14:21:06Z", + "updated_at": "2016-09-05T14:20:22Z", + "archived": false, + "column_url": "https://api.github.com/projects/columns/367", + "content_url": "https://api.github.com/repos/api-playground/projects-test/issues/3", + "project_url": "https://api.github.com/projects/120" + } + } } } } @@ -65898,36 +69504,6 @@ } } }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error Simple", - "description": "Validation Error Simple", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "string" - } - } - } - } - } - } - }, "401": { "description": "Requires Authentication", "content": { @@ -65947,282 +69523,132 @@ } } } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - { - "required": true, - "name": "inertia", - "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" - } - ], - "category": "projects", - "subcategory": "columns" - } - } - }, - "/rate_limit": { - "get": { - "summary": "Get rate limit status for the authenticated user", - "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", - "tags": [ - "rate-limit" - ], - "operationId": "rate-limit/get", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/rate_limit/#get-rate-limit-status-for-the-authenticated-user" - }, - "parameters": [ - - ], - "responses": { - "200": { - "description": "response", + }, + "422": { + "description": "Validation Failed", "content": { "application/json": { "schema": { - "title": "Rate Limit Overview", - "description": "Rate Limit Overview", - "type": "object", - "properties": { - "resources": { + "oneOf": [ + { + "title": "Validation Error", + "description": "Validation Error", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { - "core": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset" - ] - }, - "graphql": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset" - ] - }, - "search": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset" - ] - }, - "source_import": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset" - ] + "message": { + "type": "string" }, - "integration_manifest": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - } - }, - "required": [ - "limit", - "remaining", - "reset" - ] + "documentation_url": { + "type": "string" }, - "code_scanning_upload": { - "title": "Rate Limit", - "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } } - }, - "required": [ - "limit", - "remaining", - "reset" - ] + } } - }, - "required": [ - "core", - "search" - ] + } }, - "rate": { - "title": "Rate Limit", + { + "title": "Validation Error Simple", + "description": "Validation Error Simple", "type": "object", - "properties": { - "limit": { - "type": "integer" - }, - "remaining": { - "type": "integer" - }, - "reset": { - "type": "integer" - } - }, "required": [ - "limit", - "remaining", - "reset" - ] - } - }, - "required": [ - "rate", - "resources" - ] - }, - "examples": { - "default": { - "value": { - "resources": { - "core": { - "limit": 5000, - "remaining": 4999, - "reset": 1372700873 - }, - "search": { - "limit": 30, - "remaining": 18, - "reset": 1372697452 - }, - "graphql": { - "limit": 5000, - "remaining": 4993, - "reset": 1372700389 + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" }, - "integration_manifest": { - "limit": 5000, - "remaining": 4999, - "reset": 1551806725 + "documentation_url": { + "type": "string" }, - "code_scanning_upload": { - "limit": 500, - "remaining": 499, - "reset": 1551806725 + "errors": { + "type": "array", + "items": { + "type": "string" + } } - }, - "rate": { - "limit": 5000, - "remaining": 4999, - "reset": 1372700873 } } - } - } - } - }, - "headers": { - "X-RateLimit-Limit": { - "example": 5000, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Remaining": { - "example": 4999, - "schema": { - "type": "integer" - } - }, - "X-RateLimit-Reset": { - "example": 1590701888, - "schema": { - "type": "integer", - "format": "timestamp" + ] } } } }, - "304": { - "description": "Not Modified" - }, - "404": { - "description": "Resource Not Found", + "503": { + "description": "Service Unavailable", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { + "code": { + "type": "string" + }, "message": { "type": "string" }, "documentation_url": { "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + } } } } @@ -66234,28 +69660,33 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } ], - "category": "rate-limit", - "subcategory": null + "category": "projects", + "subcategory": "cards" } } }, - "/reactions/{reaction_id}": { - "delete": { - "summary": "Delete a reaction (Legacy)", - "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/).\n\nOAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/github-ae@latest/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments).", + "/projects/columns/{column_id}/moves": { + "post": { + "summary": "Move a project column", + "description": "", "tags": [ - "reactions" + "projects" ], - "operationId": "reactions/delete-legacy", + "operationId": "projects/move-column", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#delete-a-reaction-legacy" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#move-a-project-column" }, "parameters": [ { - "name": "reaction_id", + "name": "column_id", + "description": "column_id parameter", "in": "path", "required": true, "schema": { @@ -66263,35 +69694,45 @@ } } ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "position": { + "description": "The position of the column in a project", + "example": "last", + "type": "string", + "pattern": "^(?:first|last|after:\\d+)$" + } + }, + "required": [ + "position" + ], + "type": "object" + } + } + } + }, "responses": { - "204": { - "description": "Empty response" - }, - "304": { - "description": "Not Modified" - }, - "403": { - "description": "Forbidden", + "201": { + "description": "response", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } + }, + "additionalProperties": false } } } }, - "401": { - "description": "Requires Authentication", + "304": { + "description": "Not Modified" + }, + "403": { + "description": "Forbidden", "content": { "application/json": { "schema": { @@ -66310,36 +69751,44 @@ } } }, - "410": { - "description": "Gone", + "422": { + "description": "Validation Failed", "content": { "application/json": { "schema": { - "title": "Basic Error", - "description": "Basic Error", + "title": "Validation Error Simple", + "description": "Validation Error Simple", "type": "object", + "required": [ + "message", + "documentation_url" + ], "properties": { "message": { "type": "string" }, "documentation_url": { "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } } } } } } }, - "415": { - "description": "Preview Header Missing", + "401": { + "description": "Requires Authentication", "content": { "application/json": { "schema": { + "title": "Basic Error", + "description": "Basic Error", "type": "object", - "required": [ - "message", - "documentation_url" - ], "properties": { "message": { "type": "string" @@ -66359,45 +69808,34 @@ "previews": [ { "required": true, - "name": "squirrel-girl", - "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" } ], - "removalDate": "2021-02-21", - "deprecationDate": "2020-02-26", - "category": "reactions", - "subcategory": null - }, - "deprecated": true + "category": "projects", + "subcategory": "columns" + } } }, - "/repos/{owner}/{repo}": { + "/projects/{project_id}": { "get": { - "summary": "Get a repository", - "description": "When you pass the `scarlet-witch-preview` media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.\n\nThe `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.", + "summary": "Get a project", + "description": "Gets a project by its `id`. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", "tags": [ - "repos" + "projects" ], - "operationId": "repos/get", + "operationId": "projects/get", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#get-a-repository" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects/#get-a-project" }, "parameters": [ { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", + "name": "project_id", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } } ], @@ -66407,29 +69845,61 @@ "content": { "application/json": { "schema": { - "title": "Full Repository", - "description": "Full Repository", + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", "type": "object", "properties": { + "owner_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/api-playground/projects-test" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/1002604" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/api-playground/projects-test/projects/12" + }, + "columns_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/1002604/columns" + }, "id": { "type": "integer", - "example": 1296269 + "example": 1002604 }, "node_id": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "example": "MDc6UHJvamVjdDEwMDI2MDQ=" }, "name": { - "type": "string", - "example": "Hello-World" + "description": "Name of the project", + "example": "Week One Sprint", + "type": "string" }, - "full_name": { + "body": { + "description": "Body of the project", + "example": "This project represents the sprint of the first week in January", "type": "string", - "example": "octocat/Hello-World" + "nullable": true }, - "owner": { - "nullable": true, - "allOf": [ + "number": { + "type": "integer", + "example": 1 + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "creator": { + "nullable": true, + "allOf": [ { "title": "Simple User", "description": "Simple User", @@ -66544,1450 +70014,352 @@ } ] }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { + "created_at": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + "format": "date-time", + "example": "2011-04-10T20:09:31Z" }, - "ssh_url": { + "updated_at": { "type": "string", - "example": "git@github.com:octocat/Hello-World.git" + "format": "date-time", + "example": "2014-03-03T18:58:10Z" }, - "stargazers_url": { + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + "enum": [ + "read", + "write", + "admin", + "none" + ] }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "number", + "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" + } + } + } + } + } + }, + "304": { + "description": "Not Modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires Authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" }, - "subscription_url": { + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": null + } + }, + "patch": { + "summary": "Update a project", + "description": "Updates a project board's information. Returns a `404 Not Found` status if projects are disabled. If you do not have sufficient privileges to perform this action, a `401 Unauthorized` or `410 Gone` status is returned.", + "operationId": "projects/update", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects/#update-a-project" + }, + "parameters": [ + { + "name": "project_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "Name of the project", + "example": "Week One Sprint", + "type": "string" + }, + "body": { + "description": "Body of the project", + "example": "This project represents the sprint of the first week in January", + "type": "string", + "nullable": true + }, + "state": { + "description": "State of the project; either 'open' or 'closed'", + "example": "open", + "type": "string" + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone.", + "type": "boolean" + } + }, + "type": "object" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Project", + "description": "Projects are a way to organize columns and cards of work.", + "type": "object", + "properties": { + "owner_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + "example": "https://api.github.com/repos/api-playground/projects-test" }, - "tags_url": { + "url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" + "example": "https://api.github.com/projects/1002604" }, - "teams_url": { + "html_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" + "example": "https://github.com/api-playground/projects-test/projects/12" }, - "mirror_url": { + "columns_url": { "type": "string", "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true + "example": "https://api.github.com/projects/1002604/columns" }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + "id": { + "type": "integer", + "example": 1002604 }, - "svn_url": { + "node_id": { "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" + "example": "MDc6UHJvamVjdDEwMDI2MDQ=" }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true + "name": { + "description": "Name of the project", + "example": "Week One Sprint", + "type": "string" }, - "language": { + "body": { + "description": "Body of the project", + "example": "This project represents the sprint of the first week in January", "type": "string", "nullable": true }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "type": "integer", - "example": 108 - }, - "default_branch": { - "type": "string", - "example": "master" - }, - "open_issues_count": { + "number": { "type": "integer", - "example": 0 - }, - "is_template": { - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - }, - "example": [ - "octocat", - "atom", - "electron", - "API" - ] - }, - "has_issues": { - "type": "boolean", - "example": true - }, - "has_projects": { - "type": "boolean", - "example": true - }, - "has_wiki": { - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean", - "example": true - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "type": "string", - "example": "public" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "push": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] + "example": 1 }, - "allow_rebase_merge": { - "type": "boolean", - "example": true + "state": { + "description": "State of the project; either 'open' or 'closed'", + "example": "open", + "type": "string" }, - "template_repository": { + "creator": { "nullable": true, - "type": "object", "allOf": [ { - "title": "Repository", - "description": "A git repository", + "title": "Simple User", + "description": "Simple User", "type": "object", "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer" - }, - "node_id": { + "login": { "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + "example": "octocat" }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" + "id": { + "type": "integer", + "example": 1 }, - "full_name": { + "node_id": { "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "nullable": true, - "allOf": [ - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" + "example": "MDQ6VXNlcjE=" }, - "html_url": { + "avatar_url": { "type": "string", "format": "uri", - "example": "https://github.com/octocat/Hello-World" + "example": "https://github.com/images/error/octocat_happy.gif" }, - "description": { + "gravatar_id": { "type": "string", - "example": "This your first repo!", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "fork": { - "type": "boolean" - }, "url": { "type": "string", "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" + "example": "https://api.github.com/users/octocat" }, - "merges_url": { + "html_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" + "example": "https://github.com/octocat" }, - "stargazers_url": { + "followers_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "example": "https://api.github.com/users/octocat/followers" }, - "subscribers_url": { + "following_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "subscription_url": { + "gists_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "tags_url": { + "starred_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "teams_url": { + "subscriptions_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" + "example": "https://api.github.com/users/octocat/subscriptions" }, - "mirror_url": { + "organizations_url": { "type": "string", "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true + "example": "https://api.github.com/users/octocat/orgs" }, - "hooks_url": { + "repos_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + "example": "https://api.github.com/users/octocat/repos" }, - "svn_url": { + "events_url": { "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "homepage": { + "received_events_url": { "type": "string", "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "type": "integer", - "example": 108 + "example": "https://api.github.com/users/octocat/received_events" }, - "default_branch": { - "description": "The default branch of the repository.", + "type": { "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true + "example": "User" }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "template_repository": { - "nullable": true, - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "language": { - "type": "string" - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - } - ] - }, - "temp_clone_token": { - "type": "string", - "nullable": true - }, - "allow_squash_merge": { - "type": "boolean", - "example": true - }, - "delete_branch_on_merge": { - "type": "boolean", - "example": false - }, - "allow_merge_commit": { - "type": "boolean", - "example": true - }, - "subscribers_count": { - "type": "integer", - "example": 42 - }, - "network_count": { - "type": "integer", - "example": 0 - }, - "license": { - "nullable": true, - "allOf": [ - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "organization": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { + "site_admin": { "type": "boolean" }, "starred_at": { @@ -68019,2067 +70391,1312 @@ } ] }, - "parent": { - "title": "Repository", - "description": "A git repository", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "nullable": true, - "allOf": [ - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-04-10T20:09:31Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2014-03-03T18:58:10Z" + }, + "organization_permission": { + "description": "The baseline permission that all organization members have on this project. Only present if owner is an organization.", + "type": "string", + "enum": [ + "read", + "write", + "admin", + "none" + ] + }, + "private": { + "description": "Whether or not this project can be seen by everyone. Only present if owner is an organization.", + "type": "boolean" + } + }, + "required": [ + "id", + "node_id", + "number", + "name", + "body", + "state", + "url", + "html_url", + "owner_url", + "creator", + "columns_url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "owner_url": "https://api.github.com/repos/api-playground/projects-test", + "url": "https://api.github.com/projects/1002604", + "html_url": "https://github.com/api-playground/projects-test/projects/1", + "columns_url": "https://api.github.com/projects/1002604/columns", + "id": 1002604, + "node_id": "MDc6UHJvamVjdDEwMDI2MDQ=", + "name": "Projects Documentation", + "body": "Developer documentation project for the developer site.", + "number": 1, + "state": "open", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2011-04-10T20:09:31Z", + "updated_at": "2014-03-03T18:58:10Z" + } + } + } + } + } + }, + "404": { + "description": "Response if the authenticated user does not have access to the project" + }, + "304": { + "description": "Not Modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "401": { + "description": "Requires Authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": null + } + }, + "delete": { + "summary": "Delete a project", + "description": "Deletes a project board. Returns a `404 Not Found` status if projects are disabled.", + "operationId": "projects/delete", + "tags": [ + "projects" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects/#delete-a-project" + }, + "parameters": [ + { + "name": "project_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Delete Success" + }, + "304": { + "description": "Not Modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "401": { + "description": "Requires Authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": null + } + } + }, + "/projects/{project_id}/collaborators": { + "get": { + "summary": "List project collaborators", + "description": "Lists the collaborators for an organization project. For a project, the list of collaborators includes outside collaborators, organization members that are direct collaborators, organization members with access through team memberships, organization members with access through default organization permissions, and organization owners. You must be an organization owner or a project `admin` to list collaborators.", + "tags": [ + "projects" + ], + "operationId": "projects/list-collaborators", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#list-project-collaborators" + }, + "parameters": [ + { + "name": "project_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "affiliation", + "description": "Filters the collaborators by their affiliation. Can be one of: \n\\* `outside`: Outside collaborators of a project that are not a member of the project's organization. \n\\* `direct`: Collaborators with permissions to a project, regardless of organization membership status. \n\\* `all`: All collaborators the authenticated user can see.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "outside", + "direct", + "all" + ], + "default": "all" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + }, + "examples": { + "default": { + "value": [ + { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview Header Missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "template_repository": { - "nullable": true, - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { "type": "string" - }, - "site_admin": { - "type": "boolean" } } + ] + } + } + } + } + } + } + } + } + }, + "304": { + "description": "Not Modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires Authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "collaborators" + } + } + }, + "/projects/{project_id}/collaborators/{username}": { + "put": { + "summary": "Add project collaborator", + "description": "Adds a collaborator to an organization project and sets their permission level. You must be an organization owner or a project `admin` to add a collaborator.", + "tags": [ + "projects" + ], + "operationId": "projects/add-collaborator", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#add-project-collaborator" + }, + "parameters": [ + { + "name": "project_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "permission": { + "description": "The permission to grant the collaborator.", + "enum": [ + "read", + "write", + "admin" + ], + "default": "write", + "example": "write", + "type": "string" + } + } + } + } + } + }, + "responses": { + "204": { + "description": "Empty response" + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview Header Missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "304": { + "description": "Not Modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires Authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "collaborators" + } + }, + "delete": { + "summary": "Remove user as a collaborator", + "description": "Removes a collaborator from an organization project. You must be an organization owner or a project `admin` to remove a collaborator.", + "tags": [ + "projects" + ], + "operationId": "projects/remove-collaborator", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#remove-project-collaborator" + }, + "parameters": [ + { + "name": "project_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + }, + "304": { + "description": "Not Modified" + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview Header Missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "401": { + "description": "Requires Authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "collaborators" + } + } + }, + "/projects/{project_id}/collaborators/{username}/permission": { + "get": { + "summary": "Get project permission for a user", + "description": "Returns the collaborator's permission level for an organization project. Possible values for the `permission` key: `admin`, `write`, `read`, `none`. You must be an organization owner or a project `admin` to review a user's permission level.", + "tags": [ + "projects" + ], + "operationId": "projects/get-permission-for-user", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#get-project-permission-for-a-user" + }, + "parameters": [ + { + "name": "project_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "username", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Repository Collaborator Permission", + "description": "Repository Collaborator Permission", + "type": "object", + "properties": { + "permission": { + "type": "string" + }, + "user": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "language": { - "type": "string" - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string" + "id": { + "type": "integer", + "example": 1 }, - "created_at": { - "type": "string" + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "updated_at": { - "type": "string" + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "allow_rebase_merge": { - "type": "boolean" + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "temp_clone_token": { - "type": "string" + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, - "allow_squash_merge": { - "type": "boolean" + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" }, - "delete_branch_on_merge": { - "type": "boolean" + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "allow_merge_commit": { - "type": "boolean" + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "subscribers_count": { - "type": "integer" + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "network_count": { - "type": "integer" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" - } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "source": { - "title": "Repository", - "description": "A git repository", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "nullable": true, - "allOf": [ - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" }, - "pull": { - "type": "boolean" + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" }, - "triage": { - "type": "boolean" + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" }, - "push": { - "type": "boolean" + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "maintain": { + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } }, "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "template_repository": { - "nullable": true, - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "language": { - "type": "string" - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] - }, - "forks": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "anonymous_access_enabled": { - "description": "Whether anonymous git access is allowed.", - "default": true, - "type": "boolean" - }, - "code_of_conduct": { - "title": "Code Of Conduct Simple", - "description": "Code of Conduct Simple", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/github/docs/community/code_of_conduct" - }, - "key": { - "type": "string", - "example": "citizen_code_of_conduct" - }, - "name": { - "type": "string", - "example": "Citizen Code of Conduct" - }, - "html_url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" - } - }, - "required": [ - "url", - "key", - "name", - "html_url" ] } }, "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at", - "network_count", - "subscribers_count" + "permission", + "user" ] }, "examples": { - "default-response": { - "summary": "Default response", + "default": { "value": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { + "permission": "admin", + "user": { "login": "octocat", "id": 1, "node_id": "MDQ6VXNlcjE=", @@ -70098,995 +71715,117 @@ "received_events_url": "https://api.github.com/users/octocat/received_events", "type": "User", "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "forks": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "open_issues": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "pull": true, - "push": false, - "admin": false - }, - "allow_rebase_merge": true, - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World-Template", - "full_name": "octocat/Hello-World-Template", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World-Template", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World-Template", - "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World-Template.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World-Template.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World-Template.git", - "mirror_url": "git:git.example.com/octocat/Hello-World-Template", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World-Template", - "homepage": "https://github.com", - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "spdx_id": "MIT", - "url": "https://api.github.com/licenses/mit", - "node_id": "MDc6TGljZW5zZW1pdA==" - }, - "organization": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "Organization", - "site_admin": false - }, - "parent": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - }, - "source": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 } } - }, - "response-with-scarlet-witch-preview-media-type": { - "summary": "Response with scarlet-witch-preview media type", - "value": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "forks": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "open_issues": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "pull": true, - "push": false, - "admin": false - }, - "allow_rebase_merge": true, - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World-Template", - "full_name": "octocat/Hello-World-Template", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World-Template", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World-Template", - "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World-Template.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World-Template.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World-Template.git", - "mirror_url": "git:git.example.com/octocat/Hello-World-Template", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World-Template", - "homepage": "https://github.com", - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "spdx_id": "MIT", - "url": "https://api.github.com/licenses/mit", - "node_id": "MDc6TGljZW5zZW1pdA==" - }, - "organization": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "Organization", - "site_admin": false - }, - "parent": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - }, - "source": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview Header Missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - }, - "code_of_conduct": { - "key": "other", - "name": "Other", - "html_url": "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md", - "url": "https://api.github.com/repos/github/docs/community/code_of_conduct" + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } } } } @@ -71094,6 +71833,9 @@ } } }, + "304": { + "description": "Not Modified" + }, "403": { "description": "Forbidden", "content": { @@ -71114,8 +71856,8 @@ } } }, - "404": { - "description": "Resource Not Found", + "401": { + "description": "Requires Authentication", "content": { "application/json": { "schema": { @@ -71133,9 +71875,6 @@ } } } - }, - "301": { - "description": "Moved Permanently" } }, "x-github": { @@ -71143,145 +71882,845 @@ "enabledForGitHubApps": true, "previews": [ { - "required": false, - "name": "nebula", - "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" - }, - { - "required": false, - "name": "scarlet-witch", - "note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```" + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" } ], - "category": "repos", - "subcategory": null + "category": "projects", + "subcategory": "collaborators" } - }, - "patch": { - "summary": "Update a repository", - "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/github-ae@latest/rest/reference/repos#replace-all-repository-topics) endpoint.", + } + }, + "/projects/{project_id}/columns": { + "get": { + "summary": "List project columns", + "description": "", "tags": [ - "repos" + "projects" ], - "operationId": "repos/update", + "operationId": "projects/list-columns", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#update-a-repository" + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#list-project-columns" }, "parameters": [ { - "name": "owner", + "name": "project_id", "in": "path", "required": true, "schema": { - "type": "string" + "type": "integer" } }, { - "name": "repo", - "in": "path", - "required": true, + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", "schema": { - "type": "string" + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 } } ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the repository." - }, - "description": { - "type": "string", - "description": "A short description of the repository." - }, - "homepage": { - "type": "string", - "description": "A URL with more information about the repository." - }, - "private": { - "type": "boolean", - "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", - "default": false - }, - "visibility": { - "type": "string", - "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header.", - "enum": [ - "public", - "private", - "visibility", - "internal" - ] - }, - "has_issues": { - "type": "boolean", - "description": "Either `true` to enable issues for this repository or `false` to disable them.", - "default": true - }, - "has_projects": { - "type": "boolean", - "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", - "default": true - }, - "has_wiki": { - "type": "boolean", - "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", - "default": true - }, - "is_template": { - "type": "boolean", - "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", - "default": false - }, - "default_branch": { - "type": "string", - "description": "Updates the default branch for this repository." - }, - "allow_squash_merge": { - "type": "boolean", - "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", - "default": true - }, - "allow_merge_commit": { - "type": "boolean", - "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", - "default": true - }, - "allow_rebase_merge": { - "type": "boolean", - "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", - "default": true + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/columns/367" + }, + "project_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/120" + }, + "cards_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/columns/367/cards" + }, + "id": { + "description": "The unique identifier of the project column", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" + }, + "name": { + "description": "Name of the project column", + "example": "Remaining tasks", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-09-05T14:18:44Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2016-09-05T14:22:28Z" + } + }, + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + } + ] + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + }, + "304": { + "description": "Not Modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires Authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "columns" + } + }, + "post": { + "summary": "Create a project column", + "description": "", + "tags": [ + "projects" + ], + "operationId": "projects/create-column", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/projects#create-a-project-column" + }, + "parameters": [ + { + "name": "project_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "properties": { + "name": { + "description": "Name of the project column", + "example": "Remaining tasks", + "type": "string" + } + }, + "required": [ + "name" + ], + "type": "object" + } + } + } + }, + "responses": { + "201": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Project Column", + "description": "Project columns contain cards of work.", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/columns/367" + }, + "project_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/120" + }, + "cards_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/projects/columns/367/cards" + }, + "id": { + "description": "The unique identifier of the project column", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEzOlByb2plY3RDb2x1bW4zNjc=" + }, + "name": { + "description": "Name of the project column", + "example": "Remaining tasks", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2016-09-05T14:18:44Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2016-09-05T14:22:28Z" + } }, - "delete_branch_on_merge": { - "type": "boolean", - "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", - "default": false + "required": [ + "id", + "node_id", + "url", + "project_url", + "cards_url", + "name", + "created_at", + "updated_at" + ] + }, + "example": { + "url": "https://api.github.com/projects/columns/367", + "project_url": "https://api.github.com/projects/120", + "cards_url": "https://api.github.com/projects/columns/367/cards", + "id": 367, + "node_id": "MDEzOlByb2plY3RDb2x1bW4zNjc=", + "name": "To Do", + "created_at": "2016-09-05T14:18:44Z", + "updated_at": "2016-09-05T14:22:28Z" + } + } + } + }, + "304": { + "description": "Not Modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error Simple", + "description": "Validation Error Simple", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + }, + "401": { + "description": "Requires Authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "inertia", + "note": "The Projects API is currently available for developers to preview. During the preview period, the API may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-10-27-changes-to-projects-api) for full details. To access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.inertia-preview+json\n```" + } + ], + "category": "projects", + "subcategory": "columns" + } + } + }, + "/rate_limit": { + "get": { + "summary": "Get rate limit status for the authenticated user", + "description": "**Note:** Accessing this endpoint does not count against your REST API rate limit.\n\n**Note:** The `rate` object is deprecated. If you're writing new API client code or updating existing code, you should use the `core` object instead of the `rate` object. The `core` object contains the same information that is present in the `rate` object.", + "tags": [ + "rate-limit" + ], + "operationId": "rate-limit/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/rate_limit/#get-rate-limit-status-for-the-authenticated-user" + }, + "parameters": [ + + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Rate Limit Overview", + "description": "Rate Limit Overview", + "type": "object", + "properties": { + "resources": { + "type": "object", + "properties": { + "core": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset" + ] + }, + "graphql": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset" + ] + }, + "search": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset" + ] + }, + "source_import": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset" + ] + }, + "integration_manifest": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset" + ] + }, + "code_scanning_upload": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset" + ] + } + }, + "required": [ + "core", + "search" + ] + }, + "rate": { + "title": "Rate Limit", + "type": "object", + "properties": { + "limit": { + "type": "integer" + }, + "remaining": { + "type": "integer" + }, + "reset": { + "type": "integer" + } + }, + "required": [ + "limit", + "remaining", + "reset" + ] + } }, - "archived": { - "type": "boolean", - "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", - "default": false + "required": [ + "rate", + "resources" + ] + }, + "examples": { + "default": { + "value": { + "resources": { + "core": { + "limit": 5000, + "remaining": 4999, + "reset": 1372700873 + }, + "search": { + "limit": 30, + "remaining": 18, + "reset": 1372697452 + }, + "graphql": { + "limit": 5000, + "remaining": 4993, + "reset": 1372700389 + }, + "integration_manifest": { + "limit": 5000, + "remaining": 4999, + "reset": 1551806725 + }, + "code_scanning_upload": { + "limit": 500, + "remaining": 499, + "reset": 1551806725 + } + }, + "rate": { + "limit": 5000, + "remaining": 4999, + "reset": 1372700873 + } + } } } + } + }, + "headers": { + "X-RateLimit-Limit": { + "example": 5000, + "schema": { + "type": "integer" + } }, - "example": { - "name": "Hello-World", - "description": "This is your first repository", - "homepage": "https://github.com", - "private": true, - "has_issues": true, - "has_projects": true, - "has_wiki": true + "X-RateLimit-Remaining": { + "example": 4999, + "schema": { + "type": "integer" + } + }, + "X-RateLimit-Reset": { + "example": 1590701888, + "schema": { + "type": "integer", + "format": "timestamp" + } + } + } + }, + "304": { + "description": "Not Modified" + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "rate-limit", + "subcategory": null + } + } + }, + "/reactions/{reaction_id}": { + "delete": { + "summary": "Delete a reaction (Legacy)", + "description": "**Deprecation Notice:** This endpoint route is deprecated and will be removed from the Reactions API. We recommend migrating your existing code to use the new delete reactions endpoints. For more information, see this [blog post](https://developer.github.com/changes/2020-02-26-new-delete-reactions-endpoints/).\n\nOAuth access tokens require the `write:discussion` [scope](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), when deleting a [team discussion](https://docs.github.com/github-ae@latest/rest/reference/teams#discussions) or [team discussion comment](https://docs.github.com/github-ae@latest/rest/reference/teams#discussion-comments).", + "tags": [ + "reactions" + ], + "operationId": "reactions/delete-legacy", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/reactions/#delete-a-reaction-legacy" + }, + "parameters": [ + { + "name": "reaction_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + }, + "304": { + "description": "Not Modified" + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "401": { + "description": "Requires Authentication", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "410": { + "description": "Gone", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "415": { + "description": "Preview Header Missing", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } } } } }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": true, + "name": "squirrel-girl", + "note": "An additional `reactions` object in the issue comment payload is currently available for developers to preview. During the preview period, the APIs may change without advance notice. Please see the [blog post](https://developer.github.com/changes/2016-05-12-reactions-api-preview) for full details.\n\nTo access the API you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.squirrel-girl-preview\n```\nThe `reactions` key will have the following payload where `url` can be used to construct the API location for [listing and creating](https://docs.github.com/github-ae@latest/rest/reference/reactions) reactions." + } + ], + "removalDate": "2021-02-21", + "deprecationDate": "2020-02-26", + "category": "reactions", + "subcategory": null + }, + "deprecated": true + } + }, + "/repos/{owner}/{repo}": { + "get": { + "summary": "Get a repository", + "description": "When you pass the `scarlet-witch-preview` media type, requests to get a repository will also return the repository's code of conduct if it can be detected from the repository's code of conduct file.\n\nThe `parent` and `source` objects are present when the repository is a fork. `parent` is the repository this repository was forked from, `source` is the ultimate source for the network.", + "tags": [ + "repos" + ], + "operationId": "repos/get", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#get-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], "responses": { "200": { "description": "response", @@ -74859,715 +76298,21117 @@ "type": "string", "example": "Citizen Code of Conduct" }, - "html_url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" - } - }, - "required": [ - "url", - "key", - "name", - "html_url" - ] + "html_url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" + } + }, + "required": [ + "url", + "key", + "name", + "html_url" + ] + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at", + "network_count", + "subscribers_count" + ] + }, + "examples": { + "default-response": { + "summary": "Default response", + "value": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "forks": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "open_issues": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "pull": true, + "push": false, + "admin": false + }, + "allow_rebase_merge": true, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "spdx_id": "MIT", + "url": "https://api.github.com/licenses/mit", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + "organization": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "Organization", + "site_admin": false + }, + "parent": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "source": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + } + }, + "response-with-scarlet-witch-preview-media-type": { + "summary": "Response with scarlet-witch-preview media type", + "value": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "forks": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "open_issues": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "pull": true, + "push": false, + "admin": false + }, + "allow_rebase_merge": true, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "spdx_id": "MIT", + "url": "https://api.github.com/licenses/mit", + "node_id": "MDc6TGljZW5zZW1pdA==" + }, + "organization": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "Organization", + "site_admin": false + }, + "parent": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "source": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "code_of_conduct": { + "key": "other", + "name": "Other", + "html_url": "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md", + "url": "https://api.github.com/repos/github/docs/community/code_of_conduct" + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "301": { + "description": "Moved Permanently" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "nebula", + "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" + }, + { + "required": false, + "name": "scarlet-witch", + "note": "The Codes of Conduct API is currently available for developers to preview.\n\nTo access the API during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.scarlet-witch-preview+json\n```" + } + ], + "category": "repos", + "subcategory": null + } + }, + "patch": { + "summary": "Update a repository", + "description": "**Note**: To edit a repository's topics, use the [Replace all repository topics](https://docs.github.com/github-ae@latest/rest/reference/repos#replace-all-repository-topics) endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/update", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#update-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the repository." + }, + "description": { + "type": "string", + "description": "A short description of the repository." + }, + "homepage": { + "type": "string", + "description": "A URL with more information about the repository." + }, + "private": { + "type": "boolean", + "description": "Either `true` to make the repository private or `false` to make it public. Default: `false`. \n**Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private. **Note**: You will get a `422` error if the organization restricts [changing repository visibility](https://help.github.com/articles/repository-permission-levels-for-an-organization#changing-the-visibility-of-repositories) to organization owners and a non-owner tries to change the value of private.", + "default": false + }, + "visibility": { + "type": "string", + "description": "Can be `public` or `private`. If your organization is associated with an enterprise account using GitHub Enterprise Cloud or GitHub Enterprise Server 2.20+, `visibility` can also be `internal`. The `visibility` parameter overrides the `private` parameter when you use both along with the `nebula-preview` preview header.", + "enum": [ + "public", + "private", + "visibility", + "internal" + ] + }, + "has_issues": { + "type": "boolean", + "description": "Either `true` to enable issues for this repository or `false` to disable them.", + "default": true + }, + "has_projects": { + "type": "boolean", + "description": "Either `true` to enable projects for this repository or `false` to disable them. **Note:** If you're creating a repository in an organization that has disabled repository projects, the default is `false`, and if you pass `true`, the API returns an error.", + "default": true + }, + "has_wiki": { + "type": "boolean", + "description": "Either `true` to enable the wiki for this repository or `false` to disable it.", + "default": true + }, + "is_template": { + "type": "boolean", + "description": "Either `true` to make this repo available as a template repository or `false` to prevent it.", + "default": false + }, + "default_branch": { + "type": "string", + "description": "Updates the default branch for this repository." + }, + "allow_squash_merge": { + "type": "boolean", + "description": "Either `true` to allow squash-merging pull requests, or `false` to prevent squash-merging.", + "default": true + }, + "allow_merge_commit": { + "type": "boolean", + "description": "Either `true` to allow merging pull requests with a merge commit, or `false` to prevent merging pull requests with merge commits.", + "default": true + }, + "allow_rebase_merge": { + "type": "boolean", + "description": "Either `true` to allow rebase-merging pull requests, or `false` to prevent rebase-merging.", + "default": true + }, + "delete_branch_on_merge": { + "type": "boolean", + "description": "Either `true` to allow automatically deleting head branches when pull requests are merged, or `false` to prevent automatic deletion.", + "default": false + }, + "archived": { + "type": "boolean", + "description": "`true` to archive this repository. **Note**: You cannot unarchive repositories through the API.", + "default": false + } + } + }, + "example": { + "name": "Hello-World", + "description": "This is your first repository", + "homepage": "https://github.com", + "private": true, + "has_issues": true, + "has_projects": true, + "has_wiki": true + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Full Repository", + "description": "Full Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + }, + "example": [ + "octocat", + "atom", + "electron", + "API" + ] + }, + "has_issues": { + "type": "boolean", + "example": true + }, + "has_projects": { + "type": "boolean", + "example": true + }, + "has_wiki": { + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean", + "example": true + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "type": "string", + "example": "public" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "push": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "allow_rebase_merge": { + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "allOf": [ + { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + ] + }, + "temp_clone_token": { + "type": "string", + "nullable": true + }, + "allow_squash_merge": { + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer", + "example": 42 + }, + "network_count": { + "type": "integer", + "example": 0 + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "organization": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "parent": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "source": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + }, + "forks": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "anonymous_access_enabled": { + "description": "Whether anonymous git access is allowed.", + "default": true, + "type": "boolean" + }, + "code_of_conduct": { + "title": "Code Of Conduct Simple", + "description": "Code of Conduct Simple", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/github/docs/community/code_of_conduct" + }, + "key": { + "type": "string", + "example": "citizen_code_of_conduct" + }, + "name": { + "type": "string", + "example": "Citizen Code of Conduct" + }, + "html_url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://github.com/github/docs/blob/main/CODE_OF_CONDUCT.md" + } + }, + "required": [ + "url", + "key", + "name", + "html_url" + ] + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at", + "network_count", + "subscribers_count" + ] + }, + "examples": { + "default": { + "value": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://github.com/licenses/mit" + }, + "language": null, + "forks_count": 9, + "forks": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "open_issues": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "pull": true, + "push": false, + "admin": false + }, + "allow_rebase_merge": true, + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "organization": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "Organization", + "site_admin": false + }, + "parent": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + }, + "source": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": true, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "forks": 1, + "open_issues": 1, + "watchers": 1 + } + } + } + } + } + } + }, + "403": { + "description": "Forbidden", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "422": { + "description": "Validation Failed", + "content": { + "application/json": { + "schema": { + "title": "Validation Error", + "description": "Validation Error", + "type": "object", + "required": [ + "message", + "documentation_url" + ], + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + }, + "errors": { + "type": "array", + "items": { + "type": "object", + "required": [ + "code" + ], + "properties": { + "resource": { + "type": "string" + }, + "field": { + "type": "string" + }, + "message": { + "type": "string" + }, + "code": { + "type": "string" + }, + "index": { + "type": "integer" + }, + "value": { + "oneOf": [ + { + "type": "string", + "nullable": true + }, + { + "type": "integer", + "nullable": true + }, + { + "type": "array", + "nullable": true, + "items": { + "type": "string" + } + } + ] + } + } + } + } + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + { + "required": false, + "name": "nebula", + "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" + }, + { + "required": false, + "name": "baptiste", + "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" + } + ], + "category": "repos", + "subcategory": null + } + }, + "delete": { + "summary": "Delete a repository", + "description": "Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a `403 Forbidden` response.", + "tags": [ + "repos" + ], + "operationId": "repos/delete", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#delete-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + }, + "403": { + "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + }, + "example": { + "message": "Organization members cannot delete repositories.", + "documentation_url": "https://docs.github.com/github-ae@latest/rest/reference/repos#delete-a-repository" + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": null + } + } + }, + "/repos/{owner}/{repo}/actions/artifacts": { + "get": { + "summary": "List artifacts for a repository", + "description": "Lists all artifacts for a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-artifacts-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-artifacts-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "artifacts" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "artifacts": { + "type": "array", + "items": { + "title": "Artifact", + "description": "An artifact", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 5 + }, + "node_id": { + "type": "string", + "example": "MDEwOkNoZWNrU3VpdGU1" + }, + "name": { + "description": "The name of the artifact.", + "type": "string", + "example": "AdventureWorks.Framework" + }, + "size_in_bytes": { + "description": "The size in bytes of the artifact.", + "type": "integer", + "example": 12345 + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/artifacts/5" + }, + "archive_download_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip" + }, + "expired": { + "description": "Whether or not the artifact has expired.", + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "expires_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "name", + "size_in_bytes", + "url", + "archive_download_url", + "expired", + "created_at", + "expires_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "artifacts": [ + { + "id": 11, + "node_id": "MDg6QXJ0aWZhY3QxMQ==", + "name": "Rails", + "size_in_bytes": 556, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-03-21T14:59:22Z", + "updated_at": "2020-02-21T14:59:22Z" + }, + { + "id": 13, + "node_id": "MDg6QXJ0aWZhY3QxMw==", + "name": "", + "size_in_bytes": 453, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-03-21T14:59:22Z", + "updated_at": "2020-02-21T14:59:22Z" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "artifacts" + } + } + }, + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}": { + "get": { + "summary": "Get an artifact", + "description": "Gets a specific artifact for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-artifact", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-artifact" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "artifact_id", + "description": "artifact_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Artifact", + "description": "An artifact", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 5 + }, + "node_id": { + "type": "string", + "example": "MDEwOkNoZWNrU3VpdGU1" + }, + "name": { + "description": "The name of the artifact.", + "type": "string", + "example": "AdventureWorks.Framework" + }, + "size_in_bytes": { + "description": "The size in bytes of the artifact.", + "type": "integer", + "example": 12345 + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/artifacts/5" + }, + "archive_download_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip" + }, + "expired": { + "description": "Whether or not the artifact has expired.", + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "expires_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "name", + "size_in_bytes", + "url", + "archive_download_url", + "expired", + "created_at", + "expires_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 11, + "node_id": "MDg6QXJ0aWZhY3QxMQ==", + "name": "Rails", + "size_in_bytes": 556, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-01-21T14:59:22Z", + "updated_at": "2020-01-21T14:59:22Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "artifacts" + } + }, + "delete": { + "summary": "Delete an artifact", + "description": "Deletes an artifact for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-artifact", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-an-artifact" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "artifact_id", + "description": "artifact_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "artifacts" + } + } + }, + "/repos/{owner}/{repo}/actions/artifacts/{artifact_id}/{archive_format}": { + "get": { + "summary": "Download an artifact", + "description": "Gets a redirect URL to download an archive for a repository. This URL expires after 1 minute. Look for `Location:` in\nthe response header to find the URL for the download. The `:archive_format` must be `zip`. Anyone with read access to\nthe repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.\nGitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/download-artifact", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#download-an-artifact" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "artifact_id", + "description": "artifact_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "archive_format", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "302": { + "description": "response", + "headers": { + "Location": { + "example": "https://pipelines.actions.githubusercontent.com/OhgS4QRKqmgx7bKC27GKU83jnQjyeqG8oIMTge8eqtheppcmw8/_apis/pipelines/1/runs/176/signedlogcontent?urlExpires=2020-01-24T18%3A10%3A31.5729946Z&urlSigningMethod=HMACV1&urlSignature=agG73JakPYkHrh06seAkvmH7rBR4Ji4c2%2B6a2ejYh3E%3D", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "artifacts" + } + } + }, + "/repos/{owner}/{repo}/actions/jobs/{job_id}": { + "get": { + "summary": "Get a job for a workflow run", + "description": "Gets a specific job in a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-job-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-job-for-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "job_id", + "description": "job_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "202": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Job", + "description": "Information of a job execution in a workflow run", + "type": "object", + "properties": { + "id": { + "description": "The id of the job.", + "example": 21, + "type": "integer" + }, + "run_id": { + "description": "The id of the associated workflow run.", + "example": 5, + "type": "integer" + }, + "run_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5" + }, + "node_id": { + "type": "string", + "example": "MDg6Q2hlY2tSdW40" + }, + "head_sha": { + "description": "The SHA of the commit that is being run.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/jobs/21" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/runs/4", + "nullable": true + }, + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "example": "queued", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "example": "success", + "type": "string", + "nullable": true + }, + "started_at": { + "description": "The time that the job started, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string" + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the job.", + "example": "test-coverage", + "type": "string" + }, + "steps": { + "description": "Steps in this job.", + "type": "array", + "items": { + "type": "object", + "required": [ + "name", + "status", + "conclusion", + "number" + ], + "properties": { + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "example": "queued", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "example": "success", + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the job.", + "example": "test-coverage", + "type": "string" + }, + "number": { + "type": "integer", + "example": 1 + }, + "started_at": { + "description": "The time that the step started, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + } + } + } + }, + "check_run_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-runs/4" + } + }, + "required": [ + "id", + "node_id", + "run_id", + "run_url", + "head_sha", + "name", + "url", + "html_url", + "status", + "conclusion", + "started_at", + "completed_at", + "check_run_url" + ] + }, + "examples": { + "default": { + "value": { + "id": 399444496, + "run_id": 29679449, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449", + "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", + "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "status": "completed", + "conclusion": "success", + "started_at": "2020-01-20T17:42:40Z", + "completed_at": "2020-01-20T17:44:39Z", + "name": "build", + "steps": [ + { + "name": "Set up job", + "status": "completed", + "conclusion": "success", + "number": 1, + "started_at": "2020-01-20T09:42:40.000-08:00", + "completed_at": "2020-01-20T09:42:41.000-08:00" + }, + { + "name": "Run actions/checkout@v2", + "status": "completed", + "conclusion": "success", + "number": 2, + "started_at": "2020-01-20T09:42:41.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Set up Ruby", + "status": "completed", + "conclusion": "success", + "number": 3, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Run actions/cache@v2", + "status": "completed", + "conclusion": "success", + "number": 4, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:48.000-08:00" + }, + { + "name": "Install Bundler", + "status": "completed", + "conclusion": "success", + "number": 5, + "started_at": "2020-01-20T09:42:48.000-08:00", + "completed_at": "2020-01-20T09:42:52.000-08:00" + }, + { + "name": "Install Gems", + "status": "completed", + "conclusion": "success", + "number": 6, + "started_at": "2020-01-20T09:42:52.000-08:00", + "completed_at": "2020-01-20T09:42:53.000-08:00" + }, + { + "name": "Run Tests", + "status": "completed", + "conclusion": "success", + "number": 7, + "started_at": "2020-01-20T09:42:53.000-08:00", + "completed_at": "2020-01-20T09:42:59.000-08:00" + }, + { + "name": "Deploy to Heroku", + "status": "completed", + "conclusion": "success", + "number": 8, + "started_at": "2020-01-20T09:42:59.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Post actions/cache@v2", + "status": "completed", + "conclusion": "success", + "number": 16, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Complete job", + "status": "completed", + "conclusion": "success", + "number": 17, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + } + ], + "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-jobs" + } + } + }, + "/repos/{owner}/{repo}/actions/jobs/{job_id}/logs": { + "get": { + "summary": "Download job logs for a workflow run", + "description": "Gets a redirect URL to download a plain text file of logs for a workflow job. This link expires after 1 minute. Look\nfor `Location:` in the response header to find the URL for the download. Anyone with read access to the repository can\nuse this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must\nhave the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/download-job-logs-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#download-job-logs-for-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "job_id", + "description": "job_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "302": { + "description": "response", + "headers": { + "Location": { + "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/jobs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-jobs" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions": { + "get": { + "summary": "Get GitHub Actions permissions for a repository", + "description": "Gets the GitHub Actions permissions policy for a repository, including whether GitHub Actions is enabled and the actions allowed to run in the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this\nendpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/get-github-actions-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-github-actions-permissions-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether GitHub Actions is enabled on the repository." + }, + "allowed_actions": { + "type": "string", + "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "enum": [ + "all", + "local_only", + "selected" + ] + }, + "selected_actions_url": { + "type": "string", + "description": "The API URL to use to get or set the actions that are allowed to run, when `allowed_actions` is set to `selected`." + } + }, + "required": [ + "enabled", + "allowed_actions" + ] + }, + "examples": { + "default": { + "value": { + "enabled": true, + "allowed_actions": "selected", + "selected_actions_url": "https://api.github.com/repositories/42/actions/permissions/selected-actions" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set GitHub Actions permissions for a repository", + "description": "Sets the GitHub Actions permissions policy for enabling GitHub Actions and allowed actions in the repository.\n\nIf the repository belongs to an organization or enterprise that has set restrictive permissions at the organization or enterprise levels, such as `allowed_actions` to `selected` actions, then you cannot override them for the repository.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/set-github-actions-permissions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-github-actions-permissions-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether GitHub Actions is enabled on the repository." + }, + "allowed_actions": { + "type": "string", + "description": "The permissions policy that controls the actions that are allowed to run. Can be one of: `all`, `local_only`, or `selected`.", + "enum": [ + "all", + "local_only", + "selected" + ] + } + }, + "required": [ + "enabled" + ] + }, + "example": { + "enabled": true, + "allowed_actions": "selected" + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/permissions/selected-actions": { + "get": { + "summary": "Get allowed actions for a repository", + "description": "Gets the settings for selected actions that are allowed in a repository. To use this endpoint, the repository policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/get-allowed-actions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-allowed-actions-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." + }, + "verified_allowed": { + "type": "boolean", + "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators." + }, + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "items": { + "type": "string" + } + } + }, + "required": [ + "github_owned_allowed", + "patterns_allowed", + "verified_allowed" + ] + }, + "examples": { + "default": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + }, + "put": { + "summary": "Set allowed actions for a repository", + "description": "Sets the actions that are allowed in a repository. To use this endpoint, the repository permission policy for `allowed_actions` must be configured to `selected`. For more information, see \"[Set GitHub Actions permissions for a repository](#set-github-actions-permissions-for-a-repository).\"\n\nIf the repository belongs to an organization or enterprise that has `selected` actions set at the organization or enterprise levels, then you cannot override any of the allowed actions settings.\n\nTo use the `patterns_allowed` setting for private repositories, the repository must belong to an enterprise. If the repository does not belong to an enterprise, then the `patterns_allowed` setting only applies to public repositories.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `administration` repository permission to use this API.", + "operationId": "actions/set-allowed-actions-repository", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#set-allowed-actions-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "github_owned_allowed": { + "type": "boolean", + "description": "Whether GitHub-owned actions are allowed. For example, this includes the actions in the `actions` organization." + }, + "verified_allowed": { + "type": "boolean", + "description": "Whether actions in GitHub Marketplace from verified creators are allowed. Set to `true` to allow all GitHub Marketplace actions by verified creators." + }, + "patterns_allowed": { + "type": "array", + "description": "Specifies a list of string-matching patterns to allow specific action(s). Wildcards, tags, and SHAs are allowed. For example, `monalisa/octocat@*`, `monalisa/octocat@v2`, `monalisa/*`.\"", + "items": { + "type": "string" + } + } + }, + "required": [ + "github_owned_allowed", + "patterns_allowed", + "verified_allowed" + ] + }, + "examples": { + "selected_actions": { + "value": { + "github_owned_allowed": true, + "verified_allowed": false, + "patterns_allowed": [ + "monalisa/octocat@*", + "docker/*" + ] + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "permissions" + } + } + }, + "/repos/{owner}/{repo}/actions/runners": { + "get": { + "summary": "List self-hosted runners for a repository", + "description": "Lists all self-hosted runners configured in a repository. You must authenticate using an access token with the `repo` scope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-self-hosted-runners-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-self-hosted-runners-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "runners" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "runners": { + "type": "array", + "items": { + "title": "Self hosted runners", + "description": "A self hosted runner", + "type": "object", + "properties": { + "id": { + "description": "The id of the runner.", + "type": "integer", + "example": 5 + }, + "name": { + "description": "The name of the runner.", + "type": "string", + "example": "iMac" + }, + "os": { + "description": "The Operating System of the runner.", + "type": "string", + "example": "macos" + }, + "status": { + "description": "The status of the runner.", + "type": "string", + "example": "online" + }, + "busy": { + "type": "boolean" + }, + "labels": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "Unique identifier of the label." + }, + "name": { + "type": "string", + "description": "Name of the label." + }, + "type": { + "type": "string", + "description": "The type of label. Read-only labels are applied automatically when the runner is configured.", + "enum": [ + "read-only", + "custom" + ] + } + } + } + } + }, + "required": [ + "id", + "name", + "os", + "status", + "busy", + "labels" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "runners": [ + { + "id": 23, + "name": "linux_runner", + "os": "linux", + "status": "online", + "busy": true, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 11, + "name": "Linux", + "type": "read-only" + } + ] + }, + { + "id": 24, + "name": "mac_runner", + "os": "macos", + "status": "offline", + "busy": false, + "labels": [ + { + "id": 5, + "name": "self-hosted", + "type": "read-only" + }, + { + "id": 7, + "name": "X64", + "type": "read-only" + }, + { + "id": 20, + "name": "macOS", + "type": "read-only" + }, + { + "id": 21, + "name": "no-gpu", + "type": "custom" + } + ] + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runners/{runner_id}": { + "delete": { + "summary": "Delete a self-hosted runner from a repository", + "description": "Forces the removal of a self-hosted runner from a repository. You can use this endpoint to completely remove the runner when the machine you were using no longer exists.\n\nYou must authenticate using an access token with the `repo`\nscope to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-self-hosted-runner-from-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-a-self-hosted-runner-from-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "runner_id", + "description": "Unique identifier of the self-hosted runner.", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "self-hosted-runners" + } + } + }, + "/repos/{owner}/{repo}/actions/runs": { + "get": { + "summary": "List workflow runs for a repository", + "description": "Lists all workflow runs for a repository. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-workflow-runs-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-workflow-runs-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "actor", + "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "event", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "status", + "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/github-ae@latest/rest/reference/checks#create-a-check-run).\"", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "action_required", + "cancelled", + "failure", + "neutral", + "skipped", + "stale", + "success", + "timed_out", + "in_progress", + "queued", + "requested", + "waiting" + ] + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "workflow_runs" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "workflow_runs": { + "type": "array", + "items": { + "title": "Workflow Run", + "description": "An invocation of a workflow", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the workflow run.", + "example": 5 + }, + "name": { + "type": "string", + "description": "The name of the workflow run.", + "example": "Build" + }, + "node_id": { + "type": "string", + "example": "MDEwOkNoZWNrU3VpdGU1" + }, + "head_branch": { + "type": "string", + "nullable": true, + "example": "master" + }, + "head_sha": { + "description": "The SHA of the head commit that points to the version of the worflow being run.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "run_number": { + "type": "integer", + "description": "The auto incrementing run number for the workflow run.", + "example": 106 + }, + "event": { + "type": "string", + "example": "push" + }, + "status": { + "type": "string", + "nullable": true, + "example": "completed" + }, + "conclusion": { + "type": "string", + "nullable": true, + "example": "neutral" + }, + "workflow_id": { + "type": "integer", + "description": "The ID of the parent workflow.", + "example": 5 + }, + "url": { + "type": "string", + "description": "The URL to the workflow run.", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/suites/4" + }, + "pull_requests": { + "type": "array", + "nullable": true, + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "jobs_url": { + "description": "The URL to the jobs for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/jobs" + }, + "logs_url": { + "description": "The URL to download the logs for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/logs" + }, + "check_suite_url": { + "description": "The URL to the associated check suite.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-suites/12" + }, + "artifacts_url": { + "description": "The URL to the artifacts for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts" + }, + "cancel_url": { + "description": "The URL to cancel the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/cancel" + }, + "rerun_url": { + "description": "The URL to rerun the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" + }, + "workflow_url": { + "description": "The URL to the workflow.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml" + }, + "head_commit": { + "title": "Simple Commit", + "description": "Simple Commit", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "tree_id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string", + "format": "date-time" + }, + "author": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ], + "nullable": true + }, + "committer": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ], + "nullable": true + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ] + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "type": "object", + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "template_repository": { + "nullable": true, + "type": "object", + "allOf": [ + { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "head_repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "type": "object", + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "template_repository": { + "nullable": true, + "type": "object", + "allOf": [ + { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "head_repository_id": { + "type": "integer", + "example": 5 + } + }, + "required": [ + "id", + "node_id", + "head_branch", + "run_number", + "event", + "status", + "conclusion", + "head_sha", + "workflow_id", + "url", + "html_url", + "created_at", + "updated_at", + "head_commit", + "head_repository", + "repository", + "jobs_url", + "logs_url", + "check_suite_url", + "cancel_url", + "rerun_url", + "artifacts_url", + "workflow_url", + "pull_requests" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "workflow_runs": [ + { + "id": 30433642, + "name": "Build", + "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==", + "head_branch": "master", + "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d", + "run_number": 562, + "event": "push", + "status": "queued", + "conclusion": null, + "workflow_id": 159038, + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642", + "html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642", + "pull_requests": [ + + ], + "created_at": "2020-01-22T19:33:08Z", + "updated_at": "2020-01-22T19:33:08Z", + "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs", + "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs", + "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374", + "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts", + "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel", + "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun", + "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038", + "head_commit": { + "id": "acb5820ced9479c074f688cc328bf03f341a511d", + "tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223", + "message": "Create linter.yaml", + "timestamp": "2020-01-22T19:33:05Z", + "author": { + "name": "Octo Cat", + "email": "octocat@github.com" + }, + "committer": { + "name": "GitHub", + "email": "noreply@github.com" + } + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "head_repository": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "private": true, + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/octo-org/octo-repo", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments" + } + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}": { + "get": { + "summary": "Get a workflow run", + "description": "Gets a specific workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Workflow Run", + "description": "An invocation of a workflow", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the workflow run.", + "example": 5 + }, + "name": { + "type": "string", + "description": "The name of the workflow run.", + "example": "Build" + }, + "node_id": { + "type": "string", + "example": "MDEwOkNoZWNrU3VpdGU1" + }, + "head_branch": { + "type": "string", + "nullable": true, + "example": "master" + }, + "head_sha": { + "description": "The SHA of the head commit that points to the version of the worflow being run.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "run_number": { + "type": "integer", + "description": "The auto incrementing run number for the workflow run.", + "example": 106 + }, + "event": { + "type": "string", + "example": "push" + }, + "status": { + "type": "string", + "nullable": true, + "example": "completed" + }, + "conclusion": { + "type": "string", + "nullable": true, + "example": "neutral" + }, + "workflow_id": { + "type": "integer", + "description": "The ID of the parent workflow.", + "example": 5 + }, + "url": { + "type": "string", + "description": "The URL to the workflow run.", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/suites/4" + }, + "pull_requests": { + "type": "array", + "nullable": true, + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "jobs_url": { + "description": "The URL to the jobs for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/jobs" + }, + "logs_url": { + "description": "The URL to download the logs for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/logs" + }, + "check_suite_url": { + "description": "The URL to the associated check suite.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-suites/12" + }, + "artifacts_url": { + "description": "The URL to the artifacts for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts" + }, + "cancel_url": { + "description": "The URL to cancel the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/cancel" + }, + "rerun_url": { + "description": "The URL to rerun the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" + }, + "workflow_url": { + "description": "The URL to the workflow.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml" + }, + "head_commit": { + "title": "Simple Commit", + "description": "Simple Commit", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "tree_id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string", + "format": "date-time" + }, + "author": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ], + "nullable": true + }, + "committer": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ], + "nullable": true + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ] + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "type": "object", + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "template_repository": { + "nullable": true, + "type": "object", + "allOf": [ + { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "head_repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "type": "object", + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "template_repository": { + "nullable": true, + "type": "object", + "allOf": [ + { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "head_repository_id": { + "type": "integer", + "example": 5 + } + }, + "required": [ + "id", + "node_id", + "head_branch", + "run_number", + "event", + "status", + "conclusion", + "head_sha", + "workflow_id", + "url", + "html_url", + "created_at", + "updated_at", + "head_commit", + "head_repository", + "repository", + "jobs_url", + "logs_url", + "check_suite_url", + "cancel_url", + "rerun_url", + "artifacts_url", + "workflow_url", + "pull_requests" + ] + }, + "examples": { + "default": { + "value": { + "id": 30433642, + "name": "Build", + "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==", + "head_branch": "master", + "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d", + "run_number": 562, + "event": "push", + "status": "queued", + "conclusion": null, + "workflow_id": 159038, + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642", + "html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642", + "pull_requests": [ + + ], + "created_at": "2020-01-22T19:33:08Z", + "updated_at": "2020-01-22T19:33:08Z", + "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs", + "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs", + "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374", + "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts", + "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel", + "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun", + "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038", + "head_commit": { + "id": "acb5820ced9479c074f688cc328bf03f341a511d", + "tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223", + "message": "Create linter.yaml", + "timestamp": "2020-01-22T19:33:05Z", + "author": { + "name": "Octo Cat", + "email": "octocat@github.com" + }, + "committer": { + "name": "GitHub", + "email": "noreply@github.com" + } + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "head_repository": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "private": true, + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/octo-org/octo-repo", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments" + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + }, + "delete": { + "summary": "Delete a workflow run", + "description": "Delete a specific workflow run. Anyone with write access to the repository can use this endpoint. If the repository is\nprivate you must use an access token with the `repo` scope. GitHub Apps must have the `actions:write` permission to use\nthis endpoint.", + "operationId": "actions/delete-workflow-run", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/approvals": { + "get": { + "summary": "Get the review history for a workflow run", + "description": "Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-reviews-for-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-the-review-history-for-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Environment Approval", + "description": "An entry in the reviews log for environment deployments", + "type": "object", + "properties": { + "environments": { + "description": "The list of environments that were approved or rejected", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "description": "The id of the environment.", + "example": 56780428, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=" + }, + "name": { + "description": "The name of the environment.", + "example": "staging", + "type": "string" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/environments/staging" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" + }, + "created_at": { + "description": "The time that the environment was created, in ISO 8601 format.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string" + }, + "updated_at": { + "description": "The time that the environment was last updated, in ISO 8601 format.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string" + } + } + } + }, + "state": { + "description": "Whether deployment to the environment(s) was approved or rejected", + "enum": [ + "approved", + "rejected" + ], + "example": "approved", + "type": "string" + }, + "user": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "comment": { + "type": "string", + "description": "The comment submitted with the deployment review", + "example": "Ship it!" + } + }, + "required": [ + "environments", + "state", + "user", + "comment" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "state": "approved", + "comment": "Ship it!", + "environments": [ + { + "id": 161088068, + "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", + "name": "staging", + "url": "https://api.github.com/repos/github/hello-world/environments/staging", + "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging", + "created_at": "2020-11-23T22:00:40Z", + "updated_at": "2020-11-23T22:00:40Z" + } + ], + "user": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/artifacts": { + "get": { + "summary": "List workflow run artifacts", + "description": "Lists artifacts for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-workflow-run-artifacts", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-workflow-run-artifacts" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "artifacts" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "artifacts": { + "type": "array", + "items": { + "title": "Artifact", + "description": "An artifact", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 5 + }, + "node_id": { + "type": "string", + "example": "MDEwOkNoZWNrU3VpdGU1" + }, + "name": { + "description": "The name of the artifact.", + "type": "string", + "example": "AdventureWorks.Framework" + }, + "size_in_bytes": { + "description": "The size in bytes of the artifact.", + "type": "integer", + "example": 12345 + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/artifacts/5" + }, + "archive_download_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/artifacts/5/zip" + }, + "expired": { + "description": "Whether or not the artifact has expired.", + "type": "boolean" + }, + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "expires_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "nullable": true + } + }, + "required": [ + "id", + "node_id", + "name", + "size_in_bytes", + "url", + "archive_download_url", + "expired", + "created_at", + "expires_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "artifacts": [ + { + "id": 11, + "node_id": "MDg6QXJ0aWZhY3QxMQ==", + "name": "Rails", + "size_in_bytes": 556, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/11/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-03-21T14:59:22Z", + "updated_at": "2020-02-21T14:59:22Z" + }, + { + "id": 13, + "node_id": "MDg6QXJ0aWZhY3QxMw==", + "name": "", + "size_in_bytes": 453, + "url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13", + "archive_download_url": "https://api.github.com/repos/octo-org/octo-docs/actions/artifacts/13/zip", + "expired": false, + "created_at": "2020-01-10T14:59:22Z", + "expires_at": "2020-03-21T14:59:22Z", + "updated_at": "2020-02-21T14:59:22Z" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "artifacts" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/cancel": { + "post": { + "summary": "Cancel a workflow run", + "description": "Cancels a workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/cancel-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#cancel-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "202": { + "description": "response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/jobs": { + "get": { + "summary": "List jobs for a workflow run", + "description": "Lists jobs for a workflow run. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters).", + "tags": [ + "actions" + ], + "operationId": "actions/list-jobs-for-workflow-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-jobs-for-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "filter", + "description": "Filters jobs by their `completed_at` timestamp. Can be one of: \n\\* `latest`: Returns jobs from the most recent execution of the workflow run. \n\\* `all`: Returns all jobs for a workflow run, including from old executions of the workflow run.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "latest", + "all" + ], + "default": "latest" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "jobs" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "jobs": { + "type": "array", + "items": { + "title": "Job", + "description": "Information of a job execution in a workflow run", + "type": "object", + "properties": { + "id": { + "description": "The id of the job.", + "example": 21, + "type": "integer" + }, + "run_id": { + "description": "The id of the associated workflow run.", + "example": 5, + "type": "integer" + }, + "run_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5" + }, + "node_id": { + "type": "string", + "example": "MDg6Q2hlY2tSdW40" + }, + "head_sha": { + "description": "The SHA of the commit that is being run.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/jobs/21" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/runs/4", + "nullable": true + }, + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "example": "queued", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "example": "success", + "type": "string", + "nullable": true + }, + "started_at": { + "description": "The time that the job started, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string" + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the job.", + "example": "test-coverage", + "type": "string" + }, + "steps": { + "description": "Steps in this job.", + "type": "array", + "items": { + "type": "object", + "required": [ + "name", + "status", + "conclusion", + "number" + ], + "properties": { + "status": { + "description": "The phase of the lifecycle that the job is currently in.", + "example": "queued", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ] + }, + "conclusion": { + "description": "The outcome of the job.", + "example": "success", + "type": "string", + "nullable": true + }, + "name": { + "description": "The name of the job.", + "example": "test-coverage", + "type": "string" + }, + "number": { + "type": "integer", + "example": 1 + }, + "started_at": { + "description": "The time that the step started, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + }, + "completed_at": { + "description": "The time that the job finished, in ISO 8601 format.", + "example": "2019-08-08T08:00:00-07:00", + "format": "date-time", + "type": "string", + "nullable": true + } + } + } + }, + "check_run_url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-runs/4" + } + }, + "required": [ + "id", + "node_id", + "run_id", + "run_url", + "head_sha", + "name", + "url", + "html_url", + "status", + "conclusion", + "started_at", + "completed_at", + "check_run_url" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "jobs": [ + { + "id": 399444496, + "run_id": 29679449, + "run_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/29679449", + "node_id": "MDEyOldvcmtmbG93IEpvYjM5OTQ0NDQ5Ng==", + "head_sha": "f83a356604ae3c5d03e1b46ef4d1ca77d64a90b0", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/jobs/399444496", + "html_url": "https://github.com/octo-org/octo-repo/runs/399444496", + "status": "completed", + "conclusion": "success", + "started_at": "2020-01-20T17:42:40Z", + "completed_at": "2020-01-20T17:44:39Z", + "name": "build", + "steps": [ + { + "name": "Set up job", + "status": "completed", + "conclusion": "success", + "number": 1, + "started_at": "2020-01-20T09:42:40.000-08:00", + "completed_at": "2020-01-20T09:42:41.000-08:00" + }, + { + "name": "Run actions/checkout@v2", + "status": "completed", + "conclusion": "success", + "number": 2, + "started_at": "2020-01-20T09:42:41.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Set up Ruby", + "status": "completed", + "conclusion": "success", + "number": 3, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:45.000-08:00" + }, + { + "name": "Run actions/cache@v2", + "status": "completed", + "conclusion": "success", + "number": 4, + "started_at": "2020-01-20T09:42:45.000-08:00", + "completed_at": "2020-01-20T09:42:48.000-08:00" + }, + { + "name": "Install Bundler", + "status": "completed", + "conclusion": "success", + "number": 5, + "started_at": "2020-01-20T09:42:48.000-08:00", + "completed_at": "2020-01-20T09:42:52.000-08:00" + }, + { + "name": "Install Gems", + "status": "completed", + "conclusion": "success", + "number": 6, + "started_at": "2020-01-20T09:42:52.000-08:00", + "completed_at": "2020-01-20T09:42:53.000-08:00" + }, + { + "name": "Run Tests", + "status": "completed", + "conclusion": "success", + "number": 7, + "started_at": "2020-01-20T09:42:53.000-08:00", + "completed_at": "2020-01-20T09:42:59.000-08:00" + }, + { + "name": "Deploy to Heroku", + "status": "completed", + "conclusion": "success", + "number": 8, + "started_at": "2020-01-20T09:42:59.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Post actions/cache@v2", + "status": "completed", + "conclusion": "success", + "number": 16, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + }, + { + "name": "Complete job", + "status": "completed", + "conclusion": "success", + "number": 17, + "started_at": "2020-01-20T09:44:39.000-08:00", + "completed_at": "2020-01-20T09:44:39.000-08:00" + } + ], + "check_run_url": "https://api.github.com/repos/octo-org/octo-repo/check-runs/399444496" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-jobs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/logs": { + "get": { + "summary": "Download workflow run logs", + "description": "Gets a redirect URL to download an archive of log files for a workflow run. This link expires after 1 minute. Look for\n`Location:` in the response header to find the URL for the download. Anyone with read access to the repository can use\nthis endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have\nthe `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/download-workflow-run-logs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#download-workflow-run-logs" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "302": { + "description": "response", + "headers": { + "Location": { + "example": "https://pipelines.actions.githubusercontent.com/ab1f3cCFPB34Nd6imvFxpGZH5hNlDp2wijMwl2gDoO0bcrrlJj/_apis/pipelines/1/runs/19/signedlogcontent?urlExpires=2020-01-22T22%3A44%3A54.1389777Z&urlSigningMethod=HMACV1&urlSignature=2TUDfIg4fm36OJmfPy6km5QD5DLCOkBVzvhWZM8B%2BUY%3D", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + }, + "delete": { + "summary": "Delete workflow run logs", + "description": "Deletes all logs for a workflow run. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-workflow-run-logs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-workflow-run-logs" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/pending_deployments": { + "get": { + "summary": "Get pending deployments for a workflow run", + "description": "Get all deployment environments for a workflow run that are waiting for protection rules to pass.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-pending-deployments-for-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-pending-deployments-for-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Pending Deployment", + "description": "Details of a deployment that is waiting for protection rules to pass", + "type": "object", + "properties": { + "environment": { + "type": "object", + "properties": { + "id": { + "description": "The id of the environment.", + "example": 56780428, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=" + }, + "name": { + "description": "The name of the environment.", + "example": "staging", + "type": "string" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/environments/staging" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" + } + } + }, + "wait_timer": { + "type": "integer", + "description": "The set duration of the wait timer", + "example": 30 + }, + "wait_timer_started_at": { + "description": "The time that the wait timer began.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string", + "nullable": true + }, + "current_user_can_approve": { + "description": "Whether the currently authenticated user can approve the deployment", + "type": "boolean", + "example": true + }, + "reviewers": { + "type": "array", + "description": "The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of reviewer. Must be one of: `User` or `Team`", + "enum": [ + "User", + "Team" + ], + "example": "User" + }, + "reviewer": { + "anyOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + ] + } + } + } + } + }, + "required": [ + "environment", + "wait_timer", + "wait_timer_started_at", + "current_user_can_approve", + "reviewers" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "environment": { + "id": 161088068, + "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", + "name": "staging", + "url": "https://api.github.com/repos/github/hello-world/environments/staging", + "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" + }, + "wait_timer": 30, + "wait_timer_started_at": "2020-11-23T22:00:40Z", + "current_user_can_approve": true, + "reviewers": [ + { + "type": "User", + "reviewer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + { + "type": "Team", + "reviewer": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos" + } + } + ] + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + }, + "post": { + "summary": "Review pending deployments for a workflow run", + "description": "Approve or reject pending deployments that are waiting on approval by a required reviewer.\n\nAnyone with read access to the repository contents and deployments can use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/review-pending-deployments-for-run", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#review-pending-deployments-for-a-workflow-run" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "environment_ids": { + "type": "array", + "description": "The list of environment ids to approve or reject", + "example": [ + 161171787, + 161171795 + ], + "items": { + "type": "integer", + "example": 161171787 + } + }, + "state": { + "type": "string", + "description": "Whether to approve or reject deployment to the specified environments. Must be one of: `approved` or `rejected`", + "enum": [ + "approved", + "rejected" + ], + "example": "approved" + }, + "comment": { + "type": "string", + "description": "A comment to accompany the deployment review", + "example": "Ship it!" + } + }, + "required": [ + "environment_ids", + "state", + "comment" + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "title": "Deployment", + "description": "A request for a specific ref(branch,sha,tag) to be deployed", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example/deployments/1" + }, + "id": { + "description": "Unique identifier of the deployment", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOkRlcGxveW1lbnQx" + }, + "sha": { + "type": "string", + "example": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d" + }, + "ref": { + "description": "The ref to deploy. This can be a branch, tag, or sha.", + "example": "topic-branch", + "type": "string" + }, + "task": { + "description": "Parameter to specify a task to execute", + "example": "deploy", + "type": "string" + }, + "payload": { + "type": "object", + "properties": { + } + }, + "original_environment": { + "type": "string", + "example": "staging" + }, + "environment": { + "description": "Name for the target deployment environment.", + "example": "production", + "type": "string" + }, + "description": { + "type": "string", + "example": "Deploy request from hubot", + "nullable": true + }, + "creator": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2012-07-20T01:19:13Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2012-07-20T01:19:13Z" + }, + "statuses_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example/deployments/1/statuses" + }, + "repository_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example" + }, + "transient_environment": { + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", + "example": true, + "type": "boolean" + }, + "production_environment": { + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "example": true, + "type": "boolean" + }, + "performed_via_github_app": { + "nullable": true, + "allOf": [ + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "example": 5, + "type": "integer" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "client_secret": { + "type": "string", + "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + }, + "webhook_secret": { + "type": "string", + "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + }, + "pem": { + "type": "string", + "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ], + "additionalProperties": true + } + ] + } + }, + "required": [ + "id", + "node_id", + "sha", + "ref", + "task", + "environment", + "creator", + "payload", + "description", + "statuses_url", + "repository_url", + "url", + "created_at", + "updated_at" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "url": "https://api.github.com/repos/octocat/example/deployments/1", + "id": 1, + "node_id": "MDEwOkRlcGxveW1lbnQx", + "sha": "a84d88e7554fc1fa21bcbc4efae3c782a70d2b9d", + "ref": "topic-branch", + "task": "deploy", + "payload": { + }, + "original_environment": "staging", + "environment": "production", + "description": "Deploy request from hubot", + "creator": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "created_at": "2012-07-20T01:19:13Z", + "updated_at": "2012-07-20T01:19:13Z", + "statuses_url": "https://api.github.com/repos/octocat/example/deployments/1/statuses", + "repository_url": "https://api.github.com/repos/octocat/example", + "transient_environment": false, + "production_environment": true + } + ] + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/rerun": { + "post": { + "summary": "Re-run a workflow", + "description": "Re-runs your workflow run using its `id`. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/re-run-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#re-run-a-workflow" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "201": { + "description": "response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/runs/{run_id}/timing": { + "get": { + "summary": "Get workflow run usage", + "description": "Gets the number of billable minutes and total run time for a specific workflow run. Billable minutes only apply to workflows in private repositories that use GitHub AE-hosted runners. Usage is listed for each GitHub AE-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-workflow-run-usage", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-workflow-run-usage" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "run_id", + "description": "The id of the workflow run", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Workflow Run Usage", + "description": "Workflow Run Usage", + "type": "object", + "properties": { + "billable": { + "type": "object", + "properties": { + "UBUNTU": { + "type": "object", + "required": [ + "total_ms", + "jobs" + ], + "properties": { + "total_ms": { + "type": "integer" + }, + "jobs": { + "type": "integer" + } + } + }, + "MACOS": { + "type": "object", + "required": [ + "total_ms", + "jobs" + ], + "properties": { + "total_ms": { + "type": "integer" + }, + "jobs": { + "type": "integer" + } + } + }, + "WINDOWS": { + "type": "object", + "required": [ + "total_ms", + "jobs" + ], + "properties": { + "total_ms": { + "type": "integer" + }, + "jobs": { + "type": "integer" + } + } + } + } + }, + "run_duration_ms": { + "type": "integer" + } + }, + "required": [ + "billable", + "run_duration_ms" + ] + }, + "examples": { + "default": { + "value": { + "billable": { + "UBUNTU": { + "total_ms": 180000, + "jobs": 1 + }, + "MACOS": { + "total_ms": 240000, + "jobs": 4 + }, + "WINDOWS": { + "total_ms": 300000, + "jobs": 2 + } + }, + "run_duration_ms": 500000 + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": false, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflow-runs" + } + } + }, + "/repos/{owner}/{repo}/actions/secrets": { + "get": { + "summary": "List repository secrets", + "description": "Lists all secrets available in a repository without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-repo-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-repository-secrets" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "title": "Actions Secret", + "description": "Set secrets for GitHub Actions.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "created_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "secrets": [ + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + { + "name": "GIST_ID", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/repos/{owner}/{repo}/actions/secrets/public-key": { + "get": { + "summary": "Get a repository public key", + "description": "Gets your public key, which you need to encrypt secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-repo-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-repository-public-key" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "ActionsPublicKey", + "description": "The public key used for setting Actions Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "example": "1234567" + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + }, + "id": { + "type": "integer", + "example": 2 + }, + "url": { + "type": "string", + "example": "https://api.github.com/user/keys/2" + }, + "title": { + "type": "string", + "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + }, + "created_at": { + "type": "string", + "example": "2011-01-26T19:01:12Z" + } + }, + "required": [ + "key_id", + "key" + ] + }, + "examples": { + "default": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/repos/{owner}/{repo}/actions/secrets/{secret_name}": { + "get": { + "summary": "Get a repository secret", + "description": "Gets a single repository secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-repository-secret" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Actions Secret", + "description": "Set secrets for GitHub Actions.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Create or update a repository secret", + "description": "Creates or updates a repository secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "tags": [ + "actions" + ], + "operationId": "actions/create-or-update-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-a-repository-secret" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get a repository public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-repository-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + } + } + }, + "example": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret" + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Delete a repository secret", + "description": "Deletes a secret in a repository using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-repo-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-a-repository-secret" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/repos/{owner}/{repo}/actions/workflows": { + "get": { + "summary": "List repository workflows", + "description": "Lists the workflows in a repository. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-repo-workflows", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-repository-workflows" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "workflows" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "workflows": { + "type": "array", + "items": { + "title": "Workflow", + "description": "A GitHub Actions workflow", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 5 + }, + "node_id": { + "type": "string", + "example": "MDg6V29ya2Zsb3cxMg==" + }, + "name": { + "type": "string", + "example": "CI" + }, + "path": { + "type": "string", + "example": "ruby.yaml" + }, + "state": { + "type": "string", + "example": "active", + "enum": [ + "active", + "deleted" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2019-12-06T14:20:20.000Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2019-12-06T14:20:20.000Z" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/actions/setup-ruby/workflows/5" + }, + "html_url": { + "type": "string", + "example": "https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml" + }, + "badge_url": { + "type": "string", + "example": "https://github.com/actions/setup-ruby/workflows/CI/badge.svg" + }, + "deleted_at": { + "type": "string", + "format": "date-time", + "example": "2019-12-06T14:20:20.000Z" + } + }, + "required": [ + "id", + "node_id", + "name", + "path", + "state", + "url", + "html_url", + "badge_url", + "created_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "workflows": [ + { + "id": 161335, + "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=", + "name": "CI", + "path": ".github/workflows/blank.yaml", + "state": "active", + "created_at": "2020-01-08T23:48:37.000-08:00", + "updated_at": "2020-01-08T23:50:21.000-08:00", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335", + "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335", + "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg" + }, + { + "id": 269289, + "node_id": "MDE4OldvcmtmbG93IFNlY29uZGFyeTI2OTI4OQ==", + "name": "Linter", + "path": ".github/workflows/linter.yaml", + "state": "active", + "created_at": "2020-01-08T23:48:37.000-08:00", + "updated_at": "2020-01-08T23:50:21.000-08:00", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/269289", + "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/269289", + "badge_url": "https://github.com/octo-org/octo-repo/workflows/Linter/badge.svg" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflows" + } + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}": { + "get": { + "summary": "Get a workflow", + "description": "Gets a specific workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-a-workflow" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Workflow", + "description": "A GitHub Actions workflow", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 5 + }, + "node_id": { + "type": "string", + "example": "MDg6V29ya2Zsb3cxMg==" + }, + "name": { + "type": "string", + "example": "CI" + }, + "path": { + "type": "string", + "example": "ruby.yaml" + }, + "state": { + "type": "string", + "example": "active", + "enum": [ + "active", + "deleted" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2019-12-06T14:20:20.000Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2019-12-06T14:20:20.000Z" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/actions/setup-ruby/workflows/5" + }, + "html_url": { + "type": "string", + "example": "https://github.com/actions/setup-ruby/blob/master/.github/workflows/ruby.yaml" + }, + "badge_url": { + "type": "string", + "example": "https://github.com/actions/setup-ruby/workflows/CI/badge.svg" + }, + "deleted_at": { + "type": "string", + "format": "date-time", + "example": "2019-12-06T14:20:20.000Z" + } + }, + "required": [ + "id", + "node_id", + "name", + "path", + "state", + "url", + "html_url", + "badge_url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 161335, + "node_id": "MDg6V29ya2Zsb3cxNjEzMzU=", + "name": "CI", + "path": ".github/workflows/blank.yaml", + "state": "active", + "created_at": "2020-01-08T23:48:37.000-08:00", + "updated_at": "2020-01-08T23:50:21.000-08:00", + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/161335", + "html_url": "https://github.com/octo-org/octo-repo/blob/master/.github/workflows/161335", + "badge_url": "https://github.com/octo-org/octo-repo/workflows/CI/badge.svg" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflows" + } + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/disable": { + "put": { + "summary": "Disable a workflow", + "description": "Disables a workflow and sets the `state` of the workflow to `disabled_manually`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/disable-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#disable-a-workflow" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflows" + } + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/dispatches": { + "post": { + "summary": "Create a workflow dispatch event", + "description": "You can use this endpoint to manually trigger a GitHub Actions workflow run. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must configure your GitHub Actions workflow to run when the [`workflow_dispatch` webhook](/developers/webhooks-and-events/webhook-events-and-payloads#workflow_dispatch) event occurs. The `inputs` are configured in the workflow file. For more information about how to configure the `workflow_dispatch` event in the workflow file, see \"[Events that trigger workflows](/actions/reference/events-that-trigger-workflows#workflow_dispatch).\"\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint. For more information, see \"[Creating a personal access token for the command line](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line).\"", + "operationId": "actions/create-workflow-dispatch", + "tags": [ + "actions" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#create-a-workflow-dispatch-event" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The git reference for the workflow. The reference can be a branch or tag name." + }, + "inputs": { + "type": "object", + "description": "Input keys and values configured in the workflow file. The maximum number of properties is 10. Any default properties configured in the workflow file will be used when `inputs` are omitted.", + "additionalProperties": { + "type": "string" + }, + "maxProperties": 10 + } + }, + "required": [ + "ref" + ] + }, + "example": { + "ref": "topic-branch", + "inputs": { + "name": "Mona the Octocat", + "home": "San Francisco, CA" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflows" + } + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/enable": { + "put": { + "summary": "Enable a workflow", + "description": "Enables a workflow and sets the `state` of the workflow to `active`. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`.\n\nYou must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `actions:write` permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/enable-workflow", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#enable-a-workflow" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "workflows" + } + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/runs": { + "get": { + "summary": "List workflow runs", + "description": "List all workflow runs for a workflow. You can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. You can use parameters to narrow the list of results. For more information about using parameters, see [Parameters](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#parameters).\n\nAnyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope.", + "tags": [ + "actions" + ], + "operationId": "actions/list-workflow-runs", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-workflow-runs" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } + }, + { + "name": "actor", + "description": "Returns someone's workflow runs. Use the login for the user who created the `push` associated with the check suite or workflow run.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "branch", + "description": "Returns workflow runs associated with a branch. Use the name of the branch of the `push`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "event", + "description": "Returns workflow run triggered by the event you specify. For example, `push`, `pull_request` or `issue`. For more information, see \"[Events that trigger workflows](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/events-that-trigger-workflows).\"", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "status", + "description": "Returns workflow runs with the check run `status` or `conclusion` that you specify. For example, a conclusion can be `success` or a status can be `in_progress`. Only GitHub can set a status of `waiting` or `requested`. For a list of the possible `status` and `conclusion` options, see \"[Create a check run](https://docs.github.com/github-ae@latest/rest/reference/checks#create-a-check-run).\"", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "completed", + "action_required", + "cancelled", + "failure", + "neutral", + "skipped", + "stale", + "success", + "timed_out", + "in_progress", + "queued", + "requested", + "waiting" + ] + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "workflow_runs" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "workflow_runs": { + "type": "array", + "items": { + "title": "Workflow Run", + "description": "An invocation of a workflow", + "type": "object", + "properties": { + "id": { + "type": "integer", + "description": "The ID of the workflow run.", + "example": 5 + }, + "name": { + "type": "string", + "description": "The name of the workflow run.", + "example": "Build" + }, + "node_id": { + "type": "string", + "example": "MDEwOkNoZWNrU3VpdGU1" + }, + "head_branch": { + "type": "string", + "nullable": true, + "example": "master" + }, + "head_sha": { + "description": "The SHA of the head commit that points to the version of the worflow being run.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "run_number": { + "type": "integer", + "description": "The auto incrementing run number for the workflow run.", + "example": 106 + }, + "event": { + "type": "string", + "example": "push" + }, + "status": { + "type": "string", + "nullable": true, + "example": "completed" + }, + "conclusion": { + "type": "string", + "nullable": true, + "example": "neutral" + }, + "workflow_id": { + "type": "integer", + "description": "The ID of the parent workflow.", + "example": 5 + }, + "url": { + "type": "string", + "description": "The URL to the workflow run.", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/suites/4" + }, + "pull_requests": { + "type": "array", + "nullable": true, + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + }, + "jobs_url": { + "description": "The URL to the jobs for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/jobs" + }, + "logs_url": { + "description": "The URL to download the logs for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/logs" + }, + "check_suite_url": { + "description": "The URL to the associated check suite.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-suites/12" + }, + "artifacts_url": { + "description": "The URL to the artifacts for the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun/artifacts" + }, + "cancel_url": { + "description": "The URL to cancel the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/cancel" + }, + "rerun_url": { + "description": "The URL to rerun the workflow run.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/runs/5/rerun" + }, + "workflow_url": { + "description": "The URL to the workflow.", + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/actions/workflows/main.yaml" + }, + "head_commit": { + "title": "Simple Commit", + "description": "Simple Commit", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "tree_id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string", + "format": "date-time" + }, + "author": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ], + "nullable": true + }, + "committer": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ], + "nullable": true + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ] + }, + "repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "type": "object", + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "template_repository": { + "nullable": true, + "type": "object", + "allOf": [ + { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "head_repository": { + "title": "Minimal Repository", + "description": "Minimal Repository", + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 1296269 + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "type": "string", + "example": "Hello-World" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "owner": { + "type": "object", + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "template_repository": { + "nullable": true, + "type": "object", + "allOf": [ + { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "open_issues": { + "type": "integer" + }, + "watchers": { + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "head_repository_id": { + "type": "integer", + "example": 5 + } + }, + "required": [ + "id", + "node_id", + "head_branch", + "run_number", + "event", + "status", + "conclusion", + "head_sha", + "workflow_id", + "url", + "html_url", + "created_at", + "updated_at", + "head_commit", + "head_repository", + "repository", + "jobs_url", + "logs_url", + "check_suite_url", + "cancel_url", + "rerun_url", + "artifacts_url", + "workflow_url", + "pull_requests" + ] + } } - }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at", - "network_count", - "subscribers_count" - ] + } }, "examples": { "default": { "value": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://github.com/licenses/mit" - }, - "language": null, - "forks_count": 9, - "forks": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "open_issues": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "pull": true, - "push": false, - "admin": false - }, - "allow_rebase_merge": true, - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World-Template", - "full_name": "octocat/Hello-World-Template", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World-Template", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World-Template", - "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World-Template.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World-Template.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World-Template.git", - "mirror_url": "git:git.example.com/octocat/Hello-World-Template", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World-Template", - "homepage": "https://github.com", - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "organization": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "Organization", - "site_admin": false - }, - "parent": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - }, - "source": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": true, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - } - } - } - } - } - } - }, - "403": { - "description": "Forbidden", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } - } - } - } - }, - "422": { - "description": "Validation Failed", - "content": { - "application/json": { - "schema": { - "title": "Validation Error", - "description": "Validation Error", - "type": "object", - "required": [ - "message", - "documentation_url" - ], - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - }, - "errors": { - "type": "array", - "items": { - "type": "object", - "required": [ - "code" - ], - "properties": { - "resource": { - "type": "string" - }, - "field": { - "type": "string" - }, - "message": { - "type": "string" - }, - "code": { - "type": "string" - }, - "index": { - "type": "integer" + "total_count": 1, + "workflow_runs": [ + { + "id": 30433642, + "name": "Build", + "node_id": "MDEyOldvcmtmbG93IFJ1bjI2OTI4OQ==", + "head_branch": "master", + "head_sha": "acb5820ced9479c074f688cc328bf03f341a511d", + "run_number": 562, + "event": "push", + "status": "queued", + "conclusion": null, + "workflow_id": 159038, + "url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642", + "html_url": "https://github.com/octo-org/octo-repo/actions/runs/30433642", + "pull_requests": [ + + ], + "created_at": "2020-01-22T19:33:08Z", + "updated_at": "2020-01-22T19:33:08Z", + "jobs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/jobs", + "logs_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/logs", + "check_suite_url": "https://api.github.com/repos/octo-org/octo-repo/check-suites/414944374", + "artifacts_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/artifacts", + "cancel_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/cancel", + "rerun_url": "https://api.github.com/repos/octo-org/octo-repo/actions/runs/30433642/rerun", + "workflow_url": "https://api.github.com/repos/octo-org/octo-repo/actions/workflows/159038", + "head_commit": { + "id": "acb5820ced9479c074f688cc328bf03f341a511d", + "tree_id": "d23f6eedb1e1b9610bbc754ddb5197bfe7271223", + "message": "Create linter.yaml", + "timestamp": "2020-01-22T19:33:05Z", + "author": { + "name": "Octo Cat", + "email": "octocat@github.com" + }, + "committer": { + "name": "GitHub", + "email": "noreply@github.com" + } }, - "value": { - "oneOf": [ - { - "type": "string", - "nullable": true - }, - { - "type": "integer", - "nullable": true - }, - { - "type": "array", - "nullable": true, - "items": { - "type": "string" - } - } - ] + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "hooks_url": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "head_repository": { + "id": 217723378, + "node_id": "MDEwOlJlcG9zaXRvcnkyMTc3MjMzNzg=", + "name": "octo-repo", + "full_name": "octo-org/octo-repo", + "private": true, + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "html_url": "https://github.com/octo-org/octo-repo", + "description": null, + "fork": false, + "url": "https://api.github.com/repos/octo-org/octo-repo", + "forks_url": "https://api.github.com/repos/octo-org/octo-repo/forks", + "keys_url": "https://api.github.com/repos/octo-org/octo-repo/keys{/key_id}", + "collaborators_url": "https://api.github.com/repos/octo-org/octo-repo/collaborators{/collaborator}", + "teams_url": "https://api.github.com/repos/octo-org/octo-repo/teams", + "hooks_url": "https://api.github.com/repos/octo-org/octo-repo/hooks", + "issue_events_url": "https://api.github.com/repos/octo-org/octo-repo/issues/events{/number}", + "events_url": "https://api.github.com/repos/octo-org/octo-repo/events", + "assignees_url": "https://api.github.com/repos/octo-org/octo-repo/assignees{/user}", + "branches_url": "https://api.github.com/repos/octo-org/octo-repo/branches{/branch}", + "tags_url": "https://api.github.com/repos/octo-org/octo-repo/tags", + "blobs_url": "https://api.github.com/repos/octo-org/octo-repo/git/blobs{/sha}", + "git_tags_url": "https://api.github.com/repos/octo-org/octo-repo/git/tags{/sha}", + "git_refs_url": "https://api.github.com/repos/octo-org/octo-repo/git/refs{/sha}", + "trees_url": "https://api.github.com/repos/octo-org/octo-repo/git/trees{/sha}", + "statuses_url": "https://api.github.com/repos/octo-org/octo-repo/statuses/{sha}", + "languages_url": "https://api.github.com/repos/octo-org/octo-repo/languages", + "stargazers_url": "https://api.github.com/repos/octo-org/octo-repo/stargazers", + "contributors_url": "https://api.github.com/repos/octo-org/octo-repo/contributors", + "subscribers_url": "https://api.github.com/repos/octo-org/octo-repo/subscribers", + "subscription_url": "https://api.github.com/repos/octo-org/octo-repo/subscription", + "commits_url": "https://api.github.com/repos/octo-org/octo-repo/commits{/sha}", + "git_commits_url": "https://api.github.com/repos/octo-org/octo-repo/git/commits{/sha}", + "comments_url": "https://api.github.com/repos/octo-org/octo-repo/comments{/number}", + "issue_comment_url": "https://api.github.com/repos/octo-org/octo-repo/issues/comments{/number}", + "contents_url": "https://api.github.com/repos/octo-org/octo-repo/contents/{+path}", + "compare_url": "https://api.github.com/repos/octo-org/octo-repo/compare/{base}...{head}", + "merges_url": "https://api.github.com/repos/octo-org/octo-repo/merges", + "archive_url": "https://api.github.com/repos/octo-org/octo-repo/{archive_format}{/ref}", + "downloads_url": "https://api.github.com/repos/octo-org/octo-repo/downloads", + "issues_url": "https://api.github.com/repos/octo-org/octo-repo/issues{/number}", + "pulls_url": "https://api.github.com/repos/octo-org/octo-repo/pulls{/number}", + "milestones_url": "https://api.github.com/repos/octo-org/octo-repo/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octo-org/octo-repo/notifications{?since,all,participating}", + "labels_url": "https://api.github.com/repos/octo-org/octo-repo/labels{/name}", + "releases_url": "https://api.github.com/repos/octo-org/octo-repo/releases{/id}", + "deployments_url": "https://api.github.com/repos/octo-org/octo-repo/deployments" } } - } + ] } } } } - } - }, - "404": { - "description": "Resource Not Found", - "content": { - "application/json": { + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" - } - } + "type": "string" } } } @@ -75577,31 +97418,24 @@ "githubCloudOnly": false, "enabledForGitHubApps": true, "previews": [ - { - "required": false, - "name": "nebula", - "note": "You can set the visibility of a repository using the new `visibility` parameter in the [Repositories API](https://docs.github.com/github-ae@latest/rest/reference/repos/), and get a repository's visibility with a new response key. For more information, see the [blog post](https://developer.github.com/changes/2019-12-03-internal-visibility-changes/).\n\nTo access repository visibility during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n```shell\napplication/vnd.github.nebula-preview+json\n```" - }, - { - "required": false, - "name": "baptiste", - "note": "The `is_template` and `template_repository` keys are currently available for developer to preview. See [Create a repository using a template](https://docs.github.com/github-ae@latest/rest/reference/repos#create-a-repository-using-a-template) to learn how to create template repositories. To access these new response keys during the preview period, you must provide a custom [media type](https://docs.github.com/github-ae@latest/rest/overview/media-types) in the `Accept` header:\n\n```shell\napplication/vnd.github.baptiste-preview+json\n```" - } + ], - "category": "repos", - "subcategory": null + "category": "actions", + "subcategory": "workflow-runs" } - }, - "delete": { - "summary": "Delete a repository", - "description": "Deleting a repository requires admin access. If OAuth is used, the `delete_repo` scope is required.\n\nIf an organization owner has configured the organization to prevent members from deleting organization-owned\nrepositories, you will get a `403 Forbidden` response.", + } + }, + "/repos/{owner}/{repo}/actions/workflows/{workflow_id}/timing": { + "get": { + "summary": "Get workflow usage", + "description": "Gets the number of billable minutes used by a specific workflow during the current billing cycle. Billable minutes only apply to workflows in private repositories that use GitHub AE-hosted runners. Usage is listed for each GitHub AE-hosted runner operating system in milliseconds. Any job re-runs are also included in the usage. The usage does not include the multiplier for macOS and Windows runners and is not rounded up to the nearest whole minute. For more information, see \"[Managing billing for GitHub Actions](https://help.github.com/github/setting-up-and-managing-billing-and-payments-on-github/managing-billing-for-github-actions)\".\n\nYou can replace `workflow_id` with the workflow file name. For example, you could use `main.yaml`. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", "tags": [ - "repos" + "actions" ], - "operationId": "repos/delete", + "operationId": "actions/get-workflow-usage", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/repos/#delete-a-repository" + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-workflow-usage" }, "parameters": [ { @@ -75619,48 +97453,82 @@ "schema": { "type": "string" } + }, + { + "name": "workflow_id", + "in": "path", + "description": "The ID of the workflow. You can also pass the workflow file name as a string.", + "required": true, + "schema": { + "oneOf": [ + { + "type": "integer" + }, + { + "type": "string" + } + ] + } } ], "responses": { - "204": { - "description": "Empty response" - }, - "403": { - "description": "If an organization owner has configured the organization to prevent members from deleting organization-owned repositories, a member will get this response:", + "200": { + "description": "response", "content": { "application/json": { "schema": { + "title": "Workflow Usage", + "description": "Workflow Usage", "type": "object", "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "billable": { + "type": "object", + "properties": { + "UBUNTU": { + "type": "object", + "properties": { + "total_ms": { + "type": "integer" + } + } + }, + "MACOS": { + "type": "object", + "properties": { + "total_ms": { + "type": "integer" + } + } + }, + "WINDOWS": { + "type": "object", + "properties": { + "total_ms": { + "type": "integer" + } + } + } + } } - } + }, + "required": [ + "billable" + ] }, - "example": { - "message": "Organization members cannot delete repositories.", - "documentation_url": "https://docs.github.com/github-ae@latest/rest/reference/repos#delete-a-repository" - } - } - } - }, - "404": { - "description": "Resource Not Found", - "content": { - "application/json": { - "schema": { - "title": "Basic Error", - "description": "Basic Error", - "type": "object", - "properties": { - "message": { - "type": "string" - }, - "documentation_url": { - "type": "string" + "examples": { + "default": { + "value": { + "billable": { + "UBUNTU": { + "total_ms": 180000 + }, + "MACOS": { + "total_ms": 240000 + }, + "WINDOWS": { + "total_ms": 300000 + } + } } } } @@ -75670,12 +97538,12 @@ }, "x-github": { "githubCloudOnly": false, - "enabledForGitHubApps": true, + "enabledForGitHubApps": false, "previews": [ ], - "category": "repos", - "subcategory": null + "category": "actions", + "subcategory": "workflows" } } }, @@ -87682,7 +109550,7 @@ "name", "head_sha" ], - "anyOf": [ + "oneOf": [ { "properties": { "status": { @@ -87692,6 +109560,7 @@ } }, "required": [ + "status", "conclusion" ], "additionalProperties": true @@ -92117,936 +113986,2396 @@ "admin": { "type": "boolean" }, - "pull": { + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", + "type": "string" + }, + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { "type": "boolean" }, - "triage": { + "has_projects": { "type": "boolean" }, - "push": { + "has_wiki": { "type": "boolean" }, - "maintain": { + "has_pages": { "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { "type": "object", "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" + "admin": { + "type": "boolean" }, - "site_admin": { + "push": { "type": "boolean" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "pull": { + "type": "boolean" } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" } - ] - }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + } }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + "temp_clone_token": { + "type": "string" }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + "subscribers_count": { + "type": "integer" }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + "network_count": { + "type": "integer" }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" + "open_issues": { + "type": "integer" }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + "watchers": { + "type": "integer" }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + "master_branch": { + "type": "string" }, - "issues_url": { + "starred_at": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { + "example": "\"2020-07-09T00:17:42Z\"" + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] + } + ] + }, + "temp_clone_token": { + "type": "string" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + }, + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true + }, + "forks": { + "type": "integer", + "example": 0 + }, + "open_issues": { + "type": "integer", + "example": 0 + }, + "watchers": { + "type": "integer", + "example": 0 + } + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "head_commit": { + "title": "Simple Commit", + "description": "Simple Commit", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "tree_id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string", + "format": "date-time" + }, + "author": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ], + "nullable": true + }, + "committer": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ], + "nullable": true + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" + ] + }, + "latest_check_runs_count": { + "type": "integer" + }, + "check_runs_url": { + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "head_branch", + "status", + "conclusion", + "head_sha", + "url", + "before", + "after", + "created_at", + "updated_at", + "app", + "head_commit", + "repository", + "latest_check_runs_count", + "check_runs_url", + "pull_requests" + ] + }, + "examples": { + "default": { + "value": { + "id": 5, + "node_id": "MDEwOkNoZWNrU3VpdGU1", + "head_branch": "master", + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3", + "status": "completed", + "conclusion": "neutral", + "url": "https://api.github.com/repos/github/hello-world/check-suites/5", + "before": "146e867f55c26428e5f9fade55a9bbf5e95a7912", + "after": "d6fde92930d4715a2b49857d24b940956b26d2d3", + "pull_requests": [ + + ], + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + }, + "repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World", + "full_name": "octocat/Hello-World", + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World", + "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World.git", + "mirror_url": "git:git.example.com/octocat/Hello-World", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World", + "homepage": "https://github.com", + "language": null, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "size": 108, + "default_branch": "master", + "open_issues_count": 0, + "is_template": false, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "delete_branch_on_merge": true, + "subscribers_count": 42, + "network_count": 0 + }, + "head_commit": { + "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "timestamp": "2016-10-10T00:00:00Z", + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com" + }, + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com" + } + }, + "latest_check_runs_count": 1, + "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "checks", + "subcategory": "suites" + } + } + }, + "/repos/{owner}/{repo}/check-suites/preferences": { + "patch": { + "summary": "Update repository preferences for check suites", + "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/github-ae@latest/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.", + "tags": [ + "checks" + ], + "operationId": "checks/set-suites-preferences", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#update-repository-preferences-for-check-suites" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "auto_trigger_checks": { + "type": "array", + "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/github-ae@latest/rest/reference/checks#auto_trigger_checks-object) description for details.", + "items": { + "type": "object", + "properties": { + "app_id": { + "type": "integer", + "description": "The `id` of the GitHub App." + }, + "setting": { + "type": "boolean", + "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", + "default": true + } + }, + "required": [ + "app_id", + "setting" + ] + } + } + } + }, + "example": { + "auto_trigger_checks": [ + { + "app_id": 4, + "setting": false + } + ] + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Check Suite Preference", + "description": "Check suite configuration preferences for a repository.", + "type": "object", + "required": [ + "preferences", + "repository" + ], + "properties": { + "preferences": { + "type": "object", + "properties": { + "auto_trigger_checks": { + "type": "array", + "items": { + "type": "object", + "properties": { + "app_id": { + "type": "integer" + }, + "setting": { + "type": "boolean" + } + }, + "required": [ + "app_id", + "setting" + ] + } + } + } + }, + "repository": { + "title": "Repository", + "description": "A git repository", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the repository", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" + }, + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" + }, + "full_name": { + "type": "string", + "example": "octocat/Hello-World" + }, + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + "example": "mit" }, - "labels_url": { + "name": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + "example": "MIT License" }, - "languages_url": { + "url": { "type": "string", + "nullable": true, "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" + "example": "https://api.github.com/licenses/mit" }, - "merges_url": { + "spdx_id": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" + "nullable": true, + "example": "MIT" }, - "milestones_url": { + "node_id": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + "example": "MDc6TGljZW5zZW1pdA==" }, - "notifications_url": { + "html_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + "example": "octocat" }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + "id": { + "type": "integer", + "example": 1 }, - "ssh_url": { + "node_id": { "type": "string", - "example": "git@github.com:octocat/Hello-World.git" + "example": "MDQ6VXNlcjE=" }, - "stargazers_url": { + "avatar_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + "example": "https://github.com/images/error/octocat_happy.gif" }, - "statuses_url": { + "gravatar_id": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true }, - "subscribers_url": { + "url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + "example": "https://api.github.com/users/octocat" }, - "subscription_url": { + "html_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + "example": "https://github.com/octocat" }, - "tags_url": { + "followers_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" + "example": "https://api.github.com/users/octocat/followers" }, - "teams_url": { + "following_url": { "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" + "example": "https://api.github.com/users/octocat/following{/other_user}" }, - "trees_url": { + "gists_url": { "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + "example": "https://api.github.com/users/octocat/gists{/gist_id}" }, - "clone_url": { + "starred_url": { "type": "string", - "example": "https://github.com/octocat/Hello-World.git" + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" }, - "mirror_url": { + "subscriptions_url": { "type": "string", "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true + "example": "https://api.github.com/users/octocat/subscriptions" }, - "hooks_url": { + "organizations_url": { "type": "string", "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + "example": "https://api.github.com/users/octocat/orgs" }, - "svn_url": { + "repos_url": { "type": "string", "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" + "example": "https://api.github.com/users/octocat/repos" }, - "homepage": { + "events_url": { "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true + "example": "https://api.github.com/users/octocat/events{/privacy}" }, - "language": { + "received_events_url": { "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "type": "integer", - "example": 108 + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" }, - "default_branch": { - "description": "The default branch of the repository.", + "type": { "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true + "example": "User" }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, + "site_admin": { "type": "boolean" }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "template_repository": { - "nullable": true, - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" - }, - "full_name": { - "type": "string" - }, - "owner": { - "type": "object", - "properties": { - "login": { - "type": "string" - }, - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { - "type": "string" - }, - "site_admin": { - "type": "boolean" - } - } - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "language": { - "type": "string" - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - } - } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, "starred_at": { "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" + "example": "\"2020-07-09T00:17:55Z\"" } }, "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", + "avatar_url", "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", "html_url", "id", "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" - ] + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true } ] }, - "temp_clone_token": { + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" + }, + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", "type": "string" }, - "delete_branch_on_merge": { - "type": "boolean" + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true }, - "subscribers_count": { - "type": "integer" + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true }, - "network_count": { - "type": "integer" + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true }, - "license": { + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, "type": "object", "properties": { - "key": { + "id": { + "type": "integer" + }, + "node_id": { "type": "string" }, "name": { "type": "string" }, - "spdx_id": { + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { "type": "string" }, + "fork": { + "type": "boolean" + }, "url": { "type": "string" }, - "node_id": { + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" } - }, - "nullable": true + } }, - "forks": { - "type": "integer", - "example": 0 + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false + }, + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" }, "open_issues": { - "type": "integer", - "example": 0 + "type": "integer" }, "watchers": { - "type": "integer", - "example": 0 + "type": "integer" + }, + "master_branch": { + "type": "string" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" } }, "required": [ @@ -93095,162 +116424,51 @@ "tags_url", "teams_url", "trees_url", - "url" - ] - }, - "created_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "nullable": true - }, - "head_commit": { - "title": "Simple Commit", - "description": "Simple Commit", - "type": "object", - "properties": { - "id": { - "type": "string" - }, - "tree_id": { - "type": "string" - }, - "message": { - "type": "string" - }, - "timestamp": { - "type": "string", - "format": "date-time" - }, - "author": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - } - }, - "required": [ - "name", - "email" - ], - "nullable": true - }, - "committer": { - "type": "object", - "properties": { - "name": { - "type": "string" - }, - "email": { - "type": "string" - } - }, - "required": [ - "name", - "email" - ], - "nullable": true - } - }, - "required": [ - "id", - "tree_id", - "message", - "timestamp", - "author", - "committer" + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" ] - }, - "latest_check_runs_count": { - "type": "integer" - }, - "check_runs_url": { - "type": "string" } - }, - "required": [ - "id", - "node_id", - "head_branch", - "status", - "conclusion", - "head_sha", - "url", - "before", - "after", - "created_at", - "updated_at", - "app", - "head_commit", - "repository", - "latest_check_runs_count", - "check_runs_url", - "pull_requests" - ] + } }, "examples": { "default": { "value": { - "id": 5, - "node_id": "MDEwOkNoZWNrU3VpdGU1", - "head_branch": "master", - "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3", - "status": "completed", - "conclusion": "neutral", - "url": "https://api.github.com/repos/github/hello-world/check-suites/5", - "before": "146e867f55c26428e5f9fade55a9bbf5e95a7912", - "after": "d6fde92930d4715a2b49857d24b940956b26d2d3", - "pull_requests": [ - - ], - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "app": { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" + "preferences": { + "auto_trigger_checks": [ + { + "app_id": 2, + "setting": true + }, + { + "app_id": 4, + "setting": false + } ] }, "repository": { @@ -93258,127 +116476,6 @@ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World-Template", - "full_name": "octocat/Hello-World-Template", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World-Template", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World-Template", - "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World-Template.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World-Template.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World-Template.git", - "mirror_url": "git:git.example.com/octocat/Hello-World-Template", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World-Template", - "homepage": "https://github.com", - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 - }, "owner": { "login": "octocat", "id": 1, @@ -93453,7 +116550,7 @@ "size": 108, "default_branch": "master", "open_issues_count": 0, - "is_template": false, + "is_template": true, "topics": [ "octocat", "atom", @@ -93476,27 +116573,26 @@ "push": false, "pull": true }, + "allow_rebase_merge": true, + "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, "delete_branch_on_merge": true, + "allow_merge_commit": true, "subscribers_count": 42, - "network_count": 0 - }, - "head_commit": { - "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", - "timestamp": "2016-10-10T00:00:00Z", - "author": { - "name": "The Octocat", - "email": "octocat@nowhere.com" + "network_count": 0, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "http://choosealicense.com/licenses/mit/" }, - "committer": { - "name": "The Octocat", - "email": "octocat@nowhere.com" - } - }, - "latest_check_runs_count": 1, - "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs" + "forks": 1, + "open_issues": 1, + "watchers": 1 + } } } } @@ -93515,17 +116611,17 @@ } } }, - "/repos/{owner}/{repo}/check-suites/preferences": { - "patch": { - "summary": "Update repository preferences for check suites", - "description": "Changes the default automatic flow when creating check suites. By default, a check suite is automatically created each time code is pushed to a repository. When you disable the automatic creation of check suites, you can manually [Create a check suite](https://docs.github.com/github-ae@latest/rest/reference/checks#create-a-check-suite). You must have admin permissions in the repository to set preferences for check suites.", + "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { + "get": { + "summary": "Get a check suite", + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nGets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", "tags": [ "checks" ], - "operationId": "checks/set-suites-preferences", + "operationId": "checks/get-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#update-repository-preferences-for-check-suites" + "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#get-a-check-suite" }, "parameters": [ { @@ -93543,184 +116639,450 @@ "schema": { "type": "string" } - } - ], - "requestBody": { - "content": { - "application/json": { - "schema": { - "type": "object", - "properties": { - "auto_trigger_checks": { - "type": "array", - "description": "Enables or disables automatic creation of CheckSuite events upon pushes to the repository. Enabled by default. See the [`auto_trigger_checks` object](https://docs.github.com/github-ae@latest/rest/reference/checks#auto_trigger_checks-object) description for details.", - "items": { - "type": "object", - "properties": { - "app_id": { - "type": "integer", - "description": "The `id` of the GitHub App." - }, - "setting": { - "type": "boolean", - "description": "Set to `true` to enable automatic creation of CheckSuite events upon pushes to the repository, or `false` to disable them.", - "default": true - } - }, - "required": [ - "app_id", - "setting" - ] - } - } - } - }, - "example": { - "auto_trigger_checks": [ - { - "app_id": 4, - "setting": false - } - ] - } + }, + { + "name": "check_suite_id", + "description": "check_suite_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" } } - }, + ], "responses": { "200": { "description": "response", "content": { "application/json": { "schema": { - "title": "Check Suite Preference", - "description": "Check suite configuration preferences for a repository.", + "title": "CheckSuite", + "description": "A suite of checks performed on the code of a given code change", "type": "object", - "required": [ - "preferences", - "repository" - ], "properties": { - "preferences": { - "type": "object", - "properties": { - "auto_trigger_checks": { - "type": "array", - "items": { + "id": { + "type": "integer", + "example": 5 + }, + "node_id": { + "type": "string", + "example": "MDEwOkNoZWNrU3VpdGU1" + }, + "head_branch": { + "type": "string", + "example": "master", + "nullable": true + }, + "head_sha": { + "description": "The SHA of the head commit that is being checked.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "status": { + "type": "string", + "example": "completed", + "enum": [ + "queued", + "in_progress", + "completed" + ], + "nullable": true + }, + "conclusion": { + "type": "string", + "example": "neutral", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required" + ], + "nullable": true + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-suites/5", + "nullable": true + }, + "before": { + "type": "string", + "example": "146e867f55c26428e5f9fade55a9bbf5e95a7912", + "nullable": true + }, + "after": { + "type": "string", + "example": "d6fde92930d4715a2b49857d24b940956b26d2d3", + "nullable": true + }, + "pull_requests": { + "type": "array", + "items": { + "title": "Pull Request Minimal", + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "number": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "head": { "type": "object", "properties": { - "app_id": { - "type": "integer" + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + }, + "base": { + "type": "object", + "properties": { + "ref": { + "type": "string" + }, + "sha": { + "type": "string" + }, + "repo": { + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "url": { + "type": "string" + }, + "name": { + "type": "string" + } + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + }, + "nullable": true + }, + "app": { + "nullable": true, + "allOf": [ + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } }, - "setting": { - "type": "boolean" + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" } }, - "required": [ - "app_id", - "setting" - ] - } + "events": { + "description": "The list of events for the GitHub app", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "example": 5, + "type": "integer" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "client_secret": { + "type": "string", + "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + }, + "webhook_secret": { + "type": "string", + "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + }, + "pem": { + "type": "string", + "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ], + "additionalProperties": true } - } + ] }, "repository": { - "title": "Repository", - "description": "A git repository", + "title": "Minimal Repository", + "description": "Minimal Repository", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", - "example": 42, - "type": "integer" + "type": "integer", + "example": 1296269 }, "node_id": { "type": "string", "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, "name": { - "description": "The name of the repository.", "type": "string", - "example": "Team Environment" + "example": "Hello-World" }, "full_name": { "type": "string", "example": "octocat/Hello-World" }, - "license": { - "nullable": true, - "allOf": [ - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { - "type": "integer" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, "owner": { + "type": "object", "nullable": true, "allOf": [ { @@ -93838,8 +117200,6 @@ ] }, "private": { - "description": "Whether the repository is private or public.", - "default": false, "type": "boolean" }, "html_url": { @@ -93934,8 +117294,7 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" }, "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" + "type": "string" }, "issue_comment_url": { "type": "string", @@ -93984,8 +117343,7 @@ "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" }, "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" + "type": "string" }, "stargazers_url": { "type": "string", @@ -94021,13 +117379,10 @@ "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" }, "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" + "type": "string" }, "mirror_url": { "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", "nullable": true }, "hooks_url": { @@ -94036,14 +117391,10 @@ "example": "http://api.github.com/repos/octocat/Hello-World/hooks" }, "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" + "type": "string" }, "homepage": { "type": "string", - "format": "uri", - "example": "https://github.com", "nullable": true }, "language": { @@ -94051,35 +117402,25 @@ "nullable": true }, "forks_count": { - "type": "integer", - "example": 9 + "type": "integer" }, "stargazers_count": { - "type": "integer", - "example": 80 + "type": "integer" }, "watchers_count": { - "type": "integer", - "example": 80 + "type": "integer" }, "size": { - "type": "integer", - "example": 108 + "type": "integer" }, "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" + "type": "string" }, "open_issues_count": { - "type": "integer", - "example": 0 + "type": "integer" }, "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true + "type": "boolean" }, "topics": { "type": "array", @@ -94088,44 +117429,27 @@ } }, "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true + "type": "boolean" }, "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true + "type": "boolean" }, "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true + "type": "boolean" }, "has_pages": { "type": "boolean" }, "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true + "type": "boolean" }, "archived": { - "description": "Whether the repository is archived.", - "default": false, "type": "boolean" }, "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." + "type": "boolean" }, "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", "type": "string" }, "pushed_at": { @@ -94146,348 +117470,993 @@ "example": "2011-01-26T19:14:43Z", "nullable": true }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "template_repository": { - "nullable": true, + "permissions": { "type": "object", "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { - "type": "string" + "admin": { + "type": "boolean" }, - "full_name": { - "type": "string" + "push": { + "type": "boolean" }, - "owner": { + "pull": { + "type": "boolean" + } + } + }, + "template_repository": { + "nullable": true, + "type": "object", + "allOf": [ + { + "title": "Repository", + "description": "A git repository", "type": "object", "properties": { - "login": { - "type": "string" - }, "id": { + "description": "Unique identifier of the repository", + "example": 42, "type": "integer" }, "node_id": { - "type": "string" + "type": "string", + "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" }, - "avatar_url": { - "type": "string" + "name": { + "description": "The name of the repository.", + "type": "string", + "example": "Team Environment" }, - "gravatar_id": { - "type": "string" + "full_name": { + "type": "string", + "example": "octocat/Hello-World" }, - "url": { - "type": "string" + "license": { + "nullable": true, + "allOf": [ + { + "title": "License Simple", + "description": "License Simple", + "type": "object", + "properties": { + "key": { + "type": "string", + "example": "mit" + }, + "name": { + "type": "string", + "example": "MIT License" + }, + "url": { + "type": "string", + "nullable": true, + "format": "uri", + "example": "https://api.github.com/licenses/mit" + }, + "spdx_id": { + "type": "string", + "nullable": true, + "example": "MIT" + }, + "node_id": { + "type": "string", + "example": "MDc6TGljZW5zZW1pdA==" + }, + "html_url": { + "type": "string", + "format": "uri" + } + }, + "required": [ + "key", + "name", + "url", + "spdx_id", + "node_id" + ] + } + ] + }, + "forks": { + "type": "integer" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + }, + "triage": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "maintain": { + "type": "boolean" + } + }, + "required": [ + "admin", + "pull", + "push" + ] + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "private": { + "description": "Whether the repository is private or public.", + "default": false, + "type": "boolean" }, "html_url": { - "type": "string" + "type": "string", + "format": "uri", + "example": "https://github.com/octocat/Hello-World" }, - "followers_url": { + "description": { + "type": "string", + "example": "This your first repo!", + "nullable": true + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/Hello-World" + }, + "archive_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" + }, + "assignees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" + }, + "blobs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" + }, + "branches_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" + }, + "collaborators_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" + }, + "comments_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" + }, + "commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" + }, + "compare_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" + }, + "contents_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" + }, + "contributors_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/contributors" + }, + "deployments_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/deployments" + }, + "downloads_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/downloads" + }, + "events_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/events" + }, + "forks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/forks" + }, + "git_commits_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" + }, + "git_refs_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" + }, + "git_tags_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" + }, + "git_url": { + "type": "string", + "example": "git:github.com/octocat/Hello-World.git" + }, + "issue_comment_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" + }, + "issue_events_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" + }, + "issues_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" + }, + "keys_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" + }, + "labels_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" + }, + "languages_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/languages" + }, + "merges_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/merges" + }, + "milestones_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" + }, + "notifications_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" + }, + "pulls_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" + }, + "releases_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" + }, + "ssh_url": { + "type": "string", + "example": "git@github.com:octocat/Hello-World.git" + }, + "stargazers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" + }, + "statuses_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" + }, + "subscribers_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" + }, + "subscription_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/subscription" + }, + "tags_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/tags" + }, + "teams_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/teams" + }, + "trees_url": { + "type": "string", + "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" + }, + "clone_url": { + "type": "string", + "example": "https://github.com/octocat/Hello-World.git" + }, + "mirror_url": { + "type": "string", + "format": "uri", + "example": "git:git.example.com/octocat/Hello-World", + "nullable": true + }, + "hooks_url": { + "type": "string", + "format": "uri", + "example": "http://api.github.com/repos/octocat/Hello-World/hooks" + }, + "svn_url": { + "type": "string", + "format": "uri", + "example": "https://svn.github.com/octocat/Hello-World" + }, + "homepage": { + "type": "string", + "format": "uri", + "example": "https://github.com", + "nullable": true + }, + "language": { + "type": "string", + "nullable": true + }, + "forks_count": { + "type": "integer", + "example": 9 + }, + "stargazers_count": { + "type": "integer", + "example": 80 + }, + "watchers_count": { + "type": "integer", + "example": 80 + }, + "size": { + "type": "integer", + "example": 108 + }, + "default_branch": { + "description": "The default branch of the repository.", + "type": "string", + "example": "master" + }, + "open_issues_count": { + "type": "integer", + "example": 0 + }, + "is_template": { + "description": "Whether this repository acts as a template that can be used to generate new repositories.", + "default": false, + "type": "boolean", + "example": true + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "description": "Whether issues are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_projects": { + "description": "Whether projects are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_wiki": { + "description": "Whether the wiki is enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "description": "Whether downloads are enabled.", + "default": true, + "type": "boolean", + "example": true + }, + "archived": { + "description": "Whether the repository is archived.", + "default": false, + "type": "boolean" + }, + "disabled": { + "type": "boolean", + "description": "Returns whether or not this repository disabled." + }, + "visibility": { + "description": "The repository visibility: public, private, or internal.", + "default": "public", "type": "string" }, - "following_url": { + "pushed_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:06:43Z", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:01:12Z", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2011-01-26T19:14:43Z", + "nullable": true + }, + "allow_rebase_merge": { + "description": "Whether to allow rebase merges for pull requests.", + "default": true, + "type": "boolean", + "example": true + }, + "template_repository": { + "nullable": true, + "type": "object", + "properties": { + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "name": { + "type": "string" + }, + "full_name": { + "type": "string" + }, + "owner": { + "type": "object", + "properties": { + "login": { + "type": "string" + }, + "id": { + "type": "integer" + }, + "node_id": { + "type": "string" + }, + "avatar_url": { + "type": "string" + }, + "gravatar_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "html_url": { + "type": "string" + }, + "followers_url": { + "type": "string" + }, + "following_url": { + "type": "string" + }, + "gists_url": { + "type": "string" + }, + "starred_url": { + "type": "string" + }, + "subscriptions_url": { + "type": "string" + }, + "organizations_url": { + "type": "string" + }, + "repos_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "received_events_url": { + "type": "string" + }, + "type": { + "type": "string" + }, + "site_admin": { + "type": "boolean" + } + } + }, + "private": { + "type": "boolean" + }, + "html_url": { + "type": "string" + }, + "description": { + "type": "string" + }, + "fork": { + "type": "boolean" + }, + "url": { + "type": "string" + }, + "archive_url": { + "type": "string" + }, + "assignees_url": { + "type": "string" + }, + "blobs_url": { + "type": "string" + }, + "branches_url": { + "type": "string" + }, + "collaborators_url": { + "type": "string" + }, + "comments_url": { + "type": "string" + }, + "commits_url": { + "type": "string" + }, + "compare_url": { + "type": "string" + }, + "contents_url": { + "type": "string" + }, + "contributors_url": { + "type": "string" + }, + "deployments_url": { + "type": "string" + }, + "downloads_url": { + "type": "string" + }, + "events_url": { + "type": "string" + }, + "forks_url": { + "type": "string" + }, + "git_commits_url": { + "type": "string" + }, + "git_refs_url": { + "type": "string" + }, + "git_tags_url": { + "type": "string" + }, + "git_url": { + "type": "string" + }, + "issue_comment_url": { + "type": "string" + }, + "issue_events_url": { + "type": "string" + }, + "issues_url": { + "type": "string" + }, + "keys_url": { + "type": "string" + }, + "labels_url": { + "type": "string" + }, + "languages_url": { + "type": "string" + }, + "merges_url": { + "type": "string" + }, + "milestones_url": { + "type": "string" + }, + "notifications_url": { + "type": "string" + }, + "pulls_url": { + "type": "string" + }, + "releases_url": { + "type": "string" + }, + "ssh_url": { + "type": "string" + }, + "stargazers_url": { + "type": "string" + }, + "statuses_url": { + "type": "string" + }, + "subscribers_url": { + "type": "string" + }, + "subscription_url": { + "type": "string" + }, + "tags_url": { + "type": "string" + }, + "teams_url": { + "type": "string" + }, + "trees_url": { + "type": "string" + }, + "clone_url": { + "type": "string" + }, + "mirror_url": { + "type": "string" + }, + "hooks_url": { + "type": "string" + }, + "svn_url": { + "type": "string" + }, + "homepage": { + "type": "string" + }, + "language": { + "type": "string" + }, + "forks_count": { + "type": "integer" + }, + "stargazers_count": { + "type": "integer" + }, + "watchers_count": { + "type": "integer" + }, + "size": { + "type": "integer" + }, + "default_branch": { + "type": "string" + }, + "open_issues_count": { + "type": "integer" + }, + "is_template": { + "type": "boolean" + }, + "topics": { + "type": "array", + "items": { + "type": "string" + } + }, + "has_issues": { + "type": "boolean" + }, + "has_projects": { + "type": "boolean" + }, + "has_wiki": { + "type": "boolean" + }, + "has_pages": { + "type": "boolean" + }, + "has_downloads": { + "type": "boolean" + }, + "archived": { + "type": "boolean" + }, + "disabled": { + "type": "boolean" + }, + "visibility": { + "type": "string" + }, + "pushed_at": { + "type": "string" + }, + "created_at": { + "type": "string" + }, + "updated_at": { + "type": "string" + }, + "permissions": { + "type": "object", + "properties": { + "admin": { + "type": "boolean" + }, + "push": { + "type": "boolean" + }, + "pull": { + "type": "boolean" + } + } + }, + "allow_rebase_merge": { + "type": "boolean" + }, + "temp_clone_token": { + "type": "string" + }, + "allow_squash_merge": { + "type": "boolean" + }, + "delete_branch_on_merge": { + "type": "boolean" + }, + "allow_merge_commit": { + "type": "boolean" + }, + "subscribers_count": { + "type": "integer" + }, + "network_count": { + "type": "integer" + } + } + }, + "temp_clone_token": { "type": "string" }, - "gists_url": { - "type": "string" + "allow_squash_merge": { + "description": "Whether to allow squash merges for pull requests.", + "default": true, + "type": "boolean", + "example": true }, - "starred_url": { - "type": "string" + "delete_branch_on_merge": { + "description": "Whether to delete head branches when pull requests are merged", + "default": false, + "type": "boolean", + "example": false }, - "subscriptions_url": { - "type": "string" + "allow_merge_commit": { + "description": "Whether to allow merge commits for pull requests.", + "default": true, + "type": "boolean", + "example": true }, - "organizations_url": { - "type": "string" + "subscribers_count": { + "type": "integer" }, - "repos_url": { - "type": "string" + "network_count": { + "type": "integer" }, - "events_url": { - "type": "string" + "open_issues": { + "type": "integer" }, - "received_events_url": { - "type": "string" + "watchers": { + "type": "integer" }, - "type": { + "master_branch": { "type": "string" }, - "site_admin": { - "type": "boolean" - } - } - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "language": { - "type": "string" - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "pull": { - "type": "boolean" + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:42Z\"" } - } - }, - "allow_rebase_merge": { - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" + }, + "required": [ + "archive_url", + "assignees_url", + "blobs_url", + "branches_url", + "collaborators_url", + "comments_url", + "commits_url", + "compare_url", + "contents_url", + "contributors_url", + "deployments_url", + "description", + "downloads_url", + "events_url", + "fork", + "forks_url", + "full_name", + "git_commits_url", + "git_refs_url", + "git_tags_url", + "hooks_url", + "html_url", + "id", + "node_id", + "issue_comment_url", + "issue_events_url", + "issues_url", + "keys_url", + "labels_url", + "languages_url", + "merges_url", + "milestones_url", + "name", + "notifications_url", + "owner", + "private", + "pulls_url", + "releases_url", + "stargazers_url", + "statuses_url", + "subscribers_url", + "subscription_url", + "tags_url", + "teams_url", + "trees_url", + "url", + "clone_url", + "default_branch", + "forks", + "forks_count", + "git_url", + "has_downloads", + "has_issues", + "has_projects", + "has_wiki", + "has_pages", + "homepage", + "language", + "archived", + "disabled", + "mirror_url", + "open_issues", + "open_issues_count", + "license", + "pushed_at", + "size", + "ssh_url", + "stargazers_count", + "svn_url", + "watchers", + "watchers_count", + "created_at", + "updated_at" + ] } - } + ] }, "temp_clone_token": { "type": "string" }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true + "type": "boolean" }, "subscribers_count": { "type": "integer" @@ -94495,18 +118464,38 @@ "network_count": { "type": "integer" }, - "open_issues": { - "type": "integer" + "license": { + "type": "object", + "properties": { + "key": { + "type": "string" + }, + "name": { + "type": "string" + }, + "spdx_id": { + "type": "string" + }, + "url": { + "type": "string" + }, + "node_id": { + "type": "string" + } + }, + "nullable": true }, - "watchers": { - "type": "integer" + "forks": { + "type": "integer", + "example": 0 }, - "master_branch": { - "type": "string" + "open_issues": { + "type": "integer", + "example": 0 }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" + "watchers": { + "type": "integer", + "example": 0 } }, "required": [ @@ -94555,51 +118544,162 @@ "tags_url", "teams_url", "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" + "url" + ] + }, + "created_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "updated_at": { + "type": "string", + "format": "date-time", + "nullable": true + }, + "head_commit": { + "title": "Simple Commit", + "description": "Simple Commit", + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "tree_id": { + "type": "string" + }, + "message": { + "type": "string" + }, + "timestamp": { + "type": "string", + "format": "date-time" + }, + "author": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ], + "nullable": true + }, + "committer": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "email": { + "type": "string" + } + }, + "required": [ + "name", + "email" + ], + "nullable": true + } + }, + "required": [ + "id", + "tree_id", + "message", + "timestamp", + "author", + "committer" ] + }, + "latest_check_runs_count": { + "type": "integer" + }, + "check_runs_url": { + "type": "string" } - } + }, + "required": [ + "id", + "node_id", + "head_branch", + "status", + "conclusion", + "head_sha", + "url", + "before", + "after", + "created_at", + "updated_at", + "app", + "head_commit", + "repository", + "latest_check_runs_count", + "check_runs_url", + "pull_requests" + ] }, "examples": { "default": { "value": { - "preferences": { - "auto_trigger_checks": [ - { - "app_id": 2, - "setting": true - }, - { - "app_id": 4, - "setting": false - } + "id": 5, + "node_id": "MDEwOkNoZWNrU3VpdGU1", + "head_branch": "master", + "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3", + "status": "completed", + "conclusion": "neutral", + "url": "https://api.github.com/repos/github/hello-world/check-suites/5", + "before": "146e867f55c26428e5f9fade55a9bbf5e95a7912", + "after": "d6fde92930d4715a2b49857d24b940956b26d2d3", + "pull_requests": [ + + ], + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" ] }, "repository": { @@ -94607,6 +118707,127 @@ "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", "name": "Hello-World", "full_name": "octocat/Hello-World", + "template_repository": { + "id": 1296269, + "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", + "name": "Hello-World-Template", + "full_name": "octocat/Hello-World-Template", + "owner": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "private": false, + "html_url": "https://github.com/octocat/Hello-World-Template", + "description": "This your first repo!", + "fork": false, + "url": "https://api.github.com/repos/octocat/Hello-World-Template", + "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", + "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", + "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", + "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", + "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", + "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", + "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", + "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", + "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", + "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", + "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", + "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", + "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", + "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", + "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", + "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", + "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", + "git_url": "git:github.com/octocat/Hello-World-Template.git", + "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", + "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", + "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", + "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", + "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", + "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", + "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", + "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", + "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", + "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", + "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", + "ssh_url": "git@github.com:octocat/Hello-World-Template.git", + "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", + "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", + "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", + "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", + "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", + "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", + "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", + "clone_url": "https://github.com/octocat/Hello-World-Template.git", + "mirror_url": "git:git.example.com/octocat/Hello-World-Template", + "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", + "svn_url": "https://svn.github.com/octocat/Hello-World-Template", + "homepage": "https://github.com", + "language": null, + "forks": 9, + "forks_count": 9, + "stargazers_count": 80, + "watchers_count": 80, + "watchers": 80, + "size": 108, + "default_branch": "master", + "open_issues": 0, + "open_issues_count": 0, + "is_template": true, + "license": { + "key": "mit", + "name": "MIT License", + "url": "https://api.github.com/licenses/mit", + "spdx_id": "MIT", + "node_id": "MDc6TGljZW5zZW1pdA==", + "html_url": "https://api.github.com/licenses/mit" + }, + "topics": [ + "octocat", + "atom", + "electron", + "api" + ], + "has_issues": true, + "has_projects": true, + "has_wiki": true, + "has_pages": false, + "has_downloads": true, + "archived": false, + "disabled": false, + "visibility": "public", + "pushed_at": "2011-01-26T19:06:43Z", + "created_at": "2011-01-26T19:01:12Z", + "updated_at": "2011-01-26T19:14:43Z", + "permissions": { + "admin": false, + "push": false, + "pull": true + }, + "allow_rebase_merge": true, + "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", + "allow_squash_merge": true, + "delete_branch_on_merge": true, + "allow_merge_commit": true, + "subscribers_count": 42, + "network_count": 0 + }, "owner": { "login": "octocat", "id": 1, @@ -94681,7 +118902,7 @@ "size": 108, "default_branch": "master", "open_issues_count": 0, - "is_template": true, + "is_template": false, "topics": [ "octocat", "atom", @@ -94704,26 +118925,27 @@ "push": false, "pull": true }, - "allow_rebase_merge": true, - "template_repository": null, "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, "delete_branch_on_merge": true, - "allow_merge_commit": true, "subscribers_count": 42, - "network_count": 0, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "http://choosealicense.com/licenses/mit/" + "network_count": 0 + }, + "head_commit": { + "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", + "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", + "timestamp": "2016-10-10T00:00:00Z", + "author": { + "name": "The Octocat", + "email": "octocat@nowhere.com" }, - "forks": 1, - "open_issues": 1, - "watchers": 1 - } + "committer": { + "name": "The Octocat", + "email": "octocat@nowhere.com" + } + }, + "latest_check_runs_count": 1, + "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs" } } } @@ -94742,17 +118964,17 @@ } } }, - "/repos/{owner}/{repo}/check-suites/{check_suite_id}": { + "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { "get": { - "summary": "Get a check suite", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array and a `null` value for `head_branch`.\n\nGets a single check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check suites. OAuth Apps and authenticated users must have the `repo` scope to get check suites in a private repository.", + "summary": "List check runs in a check suite", + "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", "tags": [ "checks" ], - "operationId": "checks/get-suite", + "operationId": "checks/list-for-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#get-a-check-suite" + "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#list-check-runs-in-a-check-suite" }, "parameters": [ { @@ -94768,16 +118990,71 @@ "in": "path", "required": true, "schema": { - "type": "string" + "type": "string" + } + }, + { + "name": "check_suite_id", + "description": "check_suite_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "check_name", + "description": "Returns check runs with the specified `name`.", + "in": "query", + "required": false, + "schema": { + "type": "string" + } + }, + { + "name": "status", + "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ] + } + }, + { + "name": "filter", + "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "enum": [ + "latest", + "all" + ], + "default": "latest" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 } }, { - "name": "check_suite_id", - "description": "check_suite_id parameter", - "in": "path", - "required": true, + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", "schema": { - "type": "integer" + "type": "integer", + "default": 1 } } ], @@ -94787,3373 +119064,3330 @@ "content": { "application/json": { "schema": { - "title": "CheckSuite", - "description": "A suite of checks performed on the code of a given code change", "type": "object", + "required": [ + "total_count", + "check_runs" + ], "properties": { - "id": { - "type": "integer", - "example": 5 - }, - "node_id": { - "type": "string", - "example": "MDEwOkNoZWNrU3VpdGU1" - }, - "head_branch": { - "type": "string", - "example": "master", - "nullable": true - }, - "head_sha": { - "description": "The SHA of the head commit that is being checked.", - "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", - "type": "string" - }, - "status": { - "type": "string", - "example": "completed", - "enum": [ - "queued", - "in_progress", - "completed" - ], - "nullable": true - }, - "conclusion": { - "type": "string", - "example": "neutral", - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required" - ], - "nullable": true - }, - "url": { - "type": "string", - "example": "https://api.github.com/repos/github/hello-world/check-suites/5", - "nullable": true - }, - "before": { - "type": "string", - "example": "146e867f55c26428e5f9fade55a9bbf5e95a7912", - "nullable": true - }, - "after": { - "type": "string", - "example": "d6fde92930d4715a2b49857d24b940956b26d2d3", - "nullable": true + "total_count": { + "type": "integer" }, - "pull_requests": { + "check_runs": { "type": "array", "items": { - "title": "Pull Request Minimal", + "title": "CheckRun", + "description": "A check performed on the code of a given code change", "type": "object", "properties": { "id": { + "description": "The id of the check.", + "example": 21, "type": "integer" }, - "number": { - "type": "integer" + "head_sha": { + "description": "The SHA of the commit that is being checked.", + "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDg6Q2hlY2tSdW40" + }, + "external_id": { + "type": "string", + "example": "42", + "nullable": true }, "url": { - "type": "string" + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/check-runs/4" }, - "head": { + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/runs/4", + "nullable": true + }, + "details_url": { + "type": "string", + "example": "https://example.com", + "nullable": true + }, + "status": { + "description": "The phase of the lifecycle that the check is currently in.", + "example": "queued", + "type": "string", + "enum": [ + "queued", + "in_progress", + "completed" + ] + }, + "conclusion": { + "type": "string", + "example": "neutral", + "enum": [ + "success", + "failure", + "neutral", + "cancelled", + "skipped", + "timed_out", + "action_required" + ], + "nullable": true + }, + "started_at": { + "type": "string", + "format": "date-time", + "example": "2018-05-04T01:14:52Z", + "nullable": true + }, + "completed_at": { + "type": "string", + "format": "date-time", + "example": "2018-05-04T01:14:52Z", + "nullable": true + }, + "output": { "type": "object", "properties": { - "ref": { - "type": "string" + "title": { + "type": "string", + "nullable": true }, - "sha": { - "type": "string" + "summary": { + "type": "string", + "nullable": true }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "name" - ] + "text": { + "type": "string", + "nullable": true + }, + "annotations_count": { + "type": "integer" + }, + "annotations_url": { + "type": "string", + "format": "uri" } }, "required": [ - "ref", - "sha", - "repo" + "title", + "summary", + "text", + "annotations_count", + "annotations_url" ] }, - "base": { + "name": { + "description": "The name of the check.", + "example": "test-coverage", + "type": "string" + }, + "check_suite": { "type": "object", "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { + "id": { + "type": "integer" + } + }, + "required": [ + "id" + ], + "nullable": true + }, + "app": { + "nullable": true, + "allOf": [ + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", "type": "object", "properties": { "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, "type": "integer" }, - "url": { + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", "type": "string" }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "name" - ] - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - } - }, - "required": [ - "id", - "number", - "url", - "head", - "base" - ] - }, - "nullable": true - }, - "app": { - "nullable": true, - "allOf": [ - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "owner": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "example": 5, - "type": "integer" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "client_secret": { - "type": "string", - "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - }, - "webhook_secret": { - "type": "string", - "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - }, - "pem": { - "type": "string", - "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ], - "additionalProperties": true - } - ] - }, - "repository": { - "title": "Minimal Repository", - "description": "Minimal Repository", - "type": "object", - "properties": { - "id": { - "type": "integer", - "example": 1296269 - }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "type": "string", - "example": "Hello-World" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "owner": { - "type": "object", - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" - }, - "push": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - } - } - }, - "template_repository": { - "nullable": true, - "type": "object", - "allOf": [ - { - "title": "Repository", - "description": "A git repository", + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", + "type": "string" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } + }, + "additionalProperties": { + "type": "string" + }, + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" + } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "example": 5, + "type": "integer" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "client_secret": { + "type": "string", + "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + }, + "webhook_secret": { + "type": "string", + "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + }, + "pem": { + "type": "string", + "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" + } + }, + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ], + "additionalProperties": true + } + ] + }, + "pull_requests": { + "items": { + "title": "Pull Request Minimal", "type": "object", "properties": { "id": { - "description": "Unique identifier of the repository", - "example": 42, "type": "integer" }, - "node_id": { - "type": "string", - "example": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5" - }, - "name": { - "description": "The name of the repository.", - "type": "string", - "example": "Team Environment" - }, - "full_name": { - "type": "string", - "example": "octocat/Hello-World" - }, - "license": { - "nullable": true, - "allOf": [ - { - "title": "License Simple", - "description": "License Simple", - "type": "object", - "properties": { - "key": { - "type": "string", - "example": "mit" - }, - "name": { - "type": "string", - "example": "MIT License" - }, - "url": { - "type": "string", - "nullable": true, - "format": "uri", - "example": "https://api.github.com/licenses/mit" - }, - "spdx_id": { - "type": "string", - "nullable": true, - "example": "MIT" - }, - "node_id": { - "type": "string", - "example": "MDc6TGljZW5zZW1pdA==" - }, - "html_url": { - "type": "string", - "format": "uri" - } - }, - "required": [ - "key", - "name", - "url", - "spdx_id", - "node_id" - ] - } - ] - }, - "forks": { + "number": { "type": "integer" }, - "permissions": { + "url": { + "type": "string" + }, + "head": { "type": "object", "properties": { - "admin": { - "type": "boolean" - }, - "pull": { - "type": "boolean" - }, - "triage": { - "type": "boolean" + "ref": { + "type": "string" }, - "push": { - "type": "boolean" + "sha": { + "type": "string" }, - "maintain": { - "type": "boolean" - } - }, - "required": [ - "admin", - "pull", - "push" - ] - }, - "owner": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", + "repo": { "type": "object", "properties": { - "login": { - "type": "string", - "example": "octocat" - }, "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true + "type": "integer" }, "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" + "type": "string" }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" + "name": { + "type": "string" } }, "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true + "url", + "name" + ] } + }, + "required": [ + "ref", + "sha", + "repo" ] }, - "private": { - "description": "Whether the repository is private or public.", - "default": false, - "type": "boolean" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat/Hello-World" - }, - "description": { - "type": "string", - "example": "This your first repo!", - "nullable": true - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/Hello-World" - }, - "archive_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}" - }, - "assignees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/assignees{/user}" - }, - "blobs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}" - }, - "branches_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/branches{/branch}" - }, - "collaborators_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}" - }, - "comments_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/comments{/number}" - }, - "commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/commits{/sha}" - }, - "compare_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}" - }, - "contents_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/contents/{+path}" - }, - "contributors_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/contributors" - }, - "deployments_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/deployments" - }, - "downloads_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/downloads" - }, - "events_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/events" - }, - "forks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/forks" - }, - "git_commits_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/commits{/sha}" - }, - "git_refs_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/refs{/sha}" - }, - "git_tags_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/tags{/sha}" - }, - "git_url": { - "type": "string", - "example": "git:github.com/octocat/Hello-World.git" - }, - "issue_comment_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/comments{/number}" - }, - "issue_events_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues/events{/number}" - }, - "issues_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/issues{/number}" - }, - "keys_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/keys{/key_id}" - }, - "labels_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/labels{/name}" - }, - "languages_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/languages" - }, - "merges_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/merges" - }, - "milestones_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/milestones{/number}" - }, - "notifications_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}" - }, - "pulls_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/pulls{/number}" - }, - "releases_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/releases{/id}" - }, - "ssh_url": { - "type": "string", - "example": "git@github.com:octocat/Hello-World.git" - }, - "stargazers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/stargazers" - }, - "statuses_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/statuses/{sha}" - }, - "subscribers_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscribers" - }, - "subscription_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/subscription" - }, - "tags_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/tags" - }, - "teams_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/teams" - }, - "trees_url": { - "type": "string", - "example": "http://api.github.com/repos/octocat/Hello-World/git/trees{/sha}" - }, - "clone_url": { - "type": "string", - "example": "https://github.com/octocat/Hello-World.git" - }, - "mirror_url": { - "type": "string", - "format": "uri", - "example": "git:git.example.com/octocat/Hello-World", - "nullable": true - }, - "hooks_url": { - "type": "string", - "format": "uri", - "example": "http://api.github.com/repos/octocat/Hello-World/hooks" - }, - "svn_url": { - "type": "string", - "format": "uri", - "example": "https://svn.github.com/octocat/Hello-World" - }, - "homepage": { - "type": "string", - "format": "uri", - "example": "https://github.com", - "nullable": true - }, - "language": { - "type": "string", - "nullable": true - }, - "forks_count": { - "type": "integer", - "example": 9 - }, - "stargazers_count": { - "type": "integer", - "example": 80 - }, - "watchers_count": { - "type": "integer", - "example": 80 - }, - "size": { - "type": "integer", - "example": 108 - }, - "default_branch": { - "description": "The default branch of the repository.", - "type": "string", - "example": "master" - }, - "open_issues_count": { - "type": "integer", - "example": 0 - }, - "is_template": { - "description": "Whether this repository acts as a template that can be used to generate new repositories.", - "default": false, - "type": "boolean", - "example": true - }, - "topics": { - "type": "array", - "items": { - "type": "string" - } - }, - "has_issues": { - "description": "Whether issues are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_projects": { - "description": "Whether projects are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_wiki": { - "description": "Whether the wiki is enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "description": "Whether downloads are enabled.", - "default": true, - "type": "boolean", - "example": true - }, - "archived": { - "description": "Whether the repository is archived.", - "default": false, - "type": "boolean" - }, - "disabled": { - "type": "boolean", - "description": "Returns whether or not this repository disabled." - }, - "visibility": { - "description": "The repository visibility: public, private, or internal.", - "default": "public", - "type": "string" - }, - "pushed_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:06:43Z", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:01:12Z", - "nullable": true - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2011-01-26T19:14:43Z", - "nullable": true - }, - "allow_rebase_merge": { - "description": "Whether to allow rebase merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "template_repository": { - "nullable": true, + "base": { "type": "object", "properties": { - "id": { - "type": "integer" - }, - "node_id": { - "type": "string" - }, - "name": { + "ref": { "type": "string" }, - "full_name": { + "sha": { "type": "string" }, - "owner": { + "repo": { "type": "object", "properties": { - "login": { - "type": "string" - }, "id": { "type": "integer" }, - "node_id": { - "type": "string" - }, - "avatar_url": { - "type": "string" - }, - "gravatar_id": { - "type": "string" - }, "url": { "type": "string" }, - "html_url": { - "type": "string" - }, - "followers_url": { - "type": "string" - }, - "following_url": { - "type": "string" - }, - "gists_url": { - "type": "string" - }, - "starred_url": { - "type": "string" - }, - "subscriptions_url": { - "type": "string" - }, - "organizations_url": { - "type": "string" - }, - "repos_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "received_events_url": { - "type": "string" - }, - "type": { + "name": { "type": "string" - }, - "site_admin": { - "type": "boolean" } - } - }, - "private": { - "type": "boolean" - }, - "html_url": { - "type": "string" - }, - "description": { - "type": "string" - }, - "fork": { - "type": "boolean" - }, - "url": { - "type": "string" - }, - "archive_url": { - "type": "string" - }, - "assignees_url": { - "type": "string" - }, - "blobs_url": { - "type": "string" - }, - "branches_url": { - "type": "string" - }, - "collaborators_url": { - "type": "string" - }, - "comments_url": { - "type": "string" - }, - "commits_url": { - "type": "string" - }, - "compare_url": { - "type": "string" - }, - "contents_url": { - "type": "string" - }, - "contributors_url": { - "type": "string" - }, - "deployments_url": { - "type": "string" - }, - "downloads_url": { - "type": "string" - }, - "events_url": { - "type": "string" - }, - "forks_url": { - "type": "string" - }, - "git_commits_url": { - "type": "string" - }, - "git_refs_url": { - "type": "string" - }, - "git_tags_url": { - "type": "string" - }, - "git_url": { - "type": "string" - }, - "issue_comment_url": { - "type": "string" - }, - "issue_events_url": { - "type": "string" - }, - "issues_url": { - "type": "string" - }, - "keys_url": { - "type": "string" - }, - "labels_url": { - "type": "string" - }, - "languages_url": { - "type": "string" - }, - "merges_url": { - "type": "string" - }, - "milestones_url": { - "type": "string" - }, - "notifications_url": { - "type": "string" - }, - "pulls_url": { - "type": "string" - }, - "releases_url": { - "type": "string" - }, - "ssh_url": { - "type": "string" - }, - "stargazers_url": { - "type": "string" - }, - "statuses_url": { - "type": "string" - }, - "subscribers_url": { - "type": "string" - }, - "subscription_url": { - "type": "string" - }, - "tags_url": { - "type": "string" - }, - "teams_url": { - "type": "string" - }, - "trees_url": { - "type": "string" - }, - "clone_url": { - "type": "string" - }, - "mirror_url": { - "type": "string" - }, - "hooks_url": { - "type": "string" - }, - "svn_url": { - "type": "string" - }, - "homepage": { - "type": "string" - }, - "language": { - "type": "string" - }, - "forks_count": { - "type": "integer" - }, - "stargazers_count": { - "type": "integer" - }, - "watchers_count": { - "type": "integer" - }, - "size": { - "type": "integer" - }, - "default_branch": { - "type": "string" - }, - "open_issues_count": { - "type": "integer" - }, - "is_template": { - "type": "boolean" - }, - "topics": { - "type": "array", - "items": { + }, + "required": [ + "id", + "url", + "name" + ] + } + }, + "required": [ + "ref", + "sha", + "repo" + ] + } + }, + "required": [ + "id", + "number", + "url", + "head", + "base" + ] + } + }, + "deployment": { + "title": "Deployment", + "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", + "type": "object", + "properties": { + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example/deployments/1" + }, + "id": { + "description": "Unique identifier of the deployment", + "example": 42, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDEwOkRlcGxveW1lbnQx" + }, + "task": { + "description": "Parameter to specify a task to execute", + "example": "deploy", + "type": "string" + }, + "original_environment": { + "type": "string", + "example": "staging" + }, + "environment": { + "description": "Name for the target deployment environment.", + "example": "production", + "type": "string" + }, + "description": { + "type": "string", + "example": "Deploy request from hubot", + "nullable": true + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2012-07-20T01:19:13Z" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2012-07-20T01:19:13Z" + }, + "statuses_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example/deployments/1/statuses" + }, + "repository_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/repos/octocat/example" + }, + "transient_environment": { + "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", + "example": true, + "type": "boolean" + }, + "production_environment": { + "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", + "example": true, + "type": "boolean" + }, + "performed_via_github_app": { + "nullable": true, + "allOf": [ + { + "title": "GitHub app", + "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the GitHub app", + "example": 37, + "type": "integer" + }, + "slug": { + "description": "The slug name of the GitHub app", + "example": "probot-owners", + "type": "string" + }, + "node_id": { + "type": "string", + "example": "MDExOkludGVncmF0aW9uMQ==" + }, + "owner": { + "nullable": true, + "allOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + } + ] + }, + "name": { + "description": "The name of the GitHub app", + "example": "Probot Owners", "type": "string" - } - }, - "has_issues": { - "type": "boolean" - }, - "has_projects": { - "type": "boolean" - }, - "has_wiki": { - "type": "boolean" - }, - "has_pages": { - "type": "boolean" - }, - "has_downloads": { - "type": "boolean" - }, - "archived": { - "type": "boolean" - }, - "disabled": { - "type": "boolean" - }, - "visibility": { - "type": "string" - }, - "pushed_at": { - "type": "string" - }, - "created_at": { - "type": "string" - }, - "updated_at": { - "type": "string" - }, - "permissions": { - "type": "object", - "properties": { - "admin": { - "type": "boolean" + }, + "description": { + "type": "string", + "example": "The description of the app.", + "nullable": true + }, + "external_url": { + "type": "string", + "format": "uri", + "example": "https://example.com" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/apps/super-ci" + }, + "created_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "updated_at": { + "type": "string", + "format": "date-time", + "example": "2017-07-08T16:18:44-04:00" + }, + "permissions": { + "description": "The set of permissions for the GitHub app", + "type": "object", + "properties": { + "issues": { + "type": "string" + }, + "checks": { + "type": "string" + }, + "metadata": { + "type": "string" + }, + "contents": { + "type": "string" + }, + "deployments": { + "type": "string" + } }, - "push": { - "type": "boolean" + "additionalProperties": { + "type": "string" }, - "pull": { - "type": "boolean" + "example": { + "issues": "read", + "deployments": "write" + } + }, + "events": { + "description": "The list of events for the GitHub app", + "example": [ + "label", + "deployment" + ], + "type": "array", + "items": { + "type": "string" } + }, + "installations_count": { + "description": "The number of installations associated with the GitHub app", + "example": 5, + "type": "integer" + }, + "client_id": { + "type": "string", + "example": "\"Iv1.25b5d1e65ffc4022\"" + }, + "client_secret": { + "type": "string", + "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" + }, + "webhook_secret": { + "type": "string", + "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" + }, + "pem": { + "type": "string", + "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" } }, - "allow_rebase_merge": { - "type": "boolean" - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "type": "boolean" - }, - "delete_branch_on_merge": { - "type": "boolean" - }, - "allow_merge_commit": { - "type": "boolean" - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - } + "required": [ + "id", + "node_id", + "owner", + "name", + "description", + "external_url", + "html_url", + "created_at", + "updated_at", + "permissions", + "events" + ], + "additionalProperties": true } - }, - "temp_clone_token": { - "type": "string" - }, - "allow_squash_merge": { - "description": "Whether to allow squash merges for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "delete_branch_on_merge": { - "description": "Whether to delete head branches when pull requests are merged", - "default": false, - "type": "boolean", - "example": false - }, - "allow_merge_commit": { - "description": "Whether to allow merge commits for pull requests.", - "default": true, - "type": "boolean", - "example": true - }, - "subscribers_count": { - "type": "integer" - }, - "network_count": { - "type": "integer" - }, - "open_issues": { - "type": "integer" - }, - "watchers": { - "type": "integer" - }, - "master_branch": { - "type": "string" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:42Z\"" + ] + } + }, + "required": [ + "id", + "node_id", + "task", + "environment", + "description", + "statuses_url", + "repository_url", + "url", + "created_at", + "updated_at" + ] + } + }, + "required": [ + "id", + "node_id", + "head_sha", + "name", + "url", + "html_url", + "details_url", + "status", + "conclusion", + "started_at", + "completed_at", + "external_id", + "check_suite", + "output", + "app", + "pull_requests" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "check_runs": [ + { + "id": 4, + "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", + "node_id": "MDg6Q2hlY2tSdW40", + "external_id": "", + "url": "https://api.github.com/repos/github/hello-world/check-runs/4", + "html_url": "https://github.com/github/hello-world/runs/4", + "details_url": "https://example.com", + "status": "completed", + "conclusion": "neutral", + "started_at": "2018-05-04T01:14:52Z", + "completed_at": "2018-05-04T01:14:52Z", + "output": { + "title": "Mighty Readme report", + "summary": "There are 0 failures, 2 warnings, and 1 notice.", + "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", + "annotations_count": 2, + "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" + }, + "name": "mighty_readme", + "check_suite": { + "id": 5 + }, + "app": { + "id": 1, + "slug": "octoapp", + "node_id": "MDExOkludGVncmF0aW9uMQ==", + "owner": { + "login": "github", + "id": 1, + "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", + "url": "https://api.github.com/orgs/github", + "repos_url": "https://api.github.com/orgs/github/repos", + "events_url": "https://api.github.com/orgs/github/events", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": true + }, + "name": "Octocat App", + "description": "", + "external_url": "https://example.com", + "html_url": "https://github.com/apps/octoapp", + "created_at": "2017-07-08T16:18:44-04:00", + "updated_at": "2017-07-08T16:18:44-04:00", + "permissions": { + "metadata": "read", + "contents": "read", + "issues": "write", + "single_file": "write" + }, + "events": [ + "push", + "pull_request" + ] + }, + "pull_requests": [ + { + "url": "https://api.github.com/repos/github/hello-world/pulls/1", + "id": 1934, + "number": 3956, + "head": { + "ref": "say-hello", + "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" } }, - "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", - "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", - "html_url", - "id", - "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", - "url", - "clone_url", - "default_branch", - "forks", - "forks_count", - "git_url", - "has_downloads", - "has_issues", - "has_projects", - "has_wiki", - "has_pages", - "homepage", - "language", - "archived", - "disabled", - "mirror_url", - "open_issues", - "open_issues_count", - "license", - "pushed_at", - "size", - "ssh_url", - "stargazers_count", - "svn_url", - "watchers", - "watchers_count", - "created_at", - "updated_at" + "base": { + "ref": "master", + "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", + "repo": { + "id": 526, + "url": "https://api.github.com/repos/github/hello-world", + "name": "hello-world" + } + } + } + ] + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "checks", + "subcategory": "runs" + } + } + }, + "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { + "post": { + "summary": "Rerequest a check suite", + "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.", + "tags": [ + "checks" + ], + "operationId": "checks/rerequest-suite", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#rerequest-a-check-suite" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "check_suite_id", + "description": "check_suite_id parameter", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + } + ], + "responses": { + "201": { + "description": "response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "checks", + "subcategory": "suites" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/alerts": { + "get": { + "summary": "List code scanning alerts for a repository", + "description": "Lists all open code scanning alerts for the default branch (usually `main`\nor `master`). You must use an access token with the `security_events` scope to use\nthis endpoint. GitHub Apps must have the `security_events` read permission to use\nthis endpoint.\n\nThe response includes a `most_recent_instance` object.\nThis provides details of the most recent instance of this alert\nfor the the default branch or for the specified Git reference\n(if you used `ref` in the request).", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/list-alerts-for-repo", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#list-code-scanning-alerts-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "tool_name", + "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + } + }, + { + "name": "tool_guid", + "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", + "in": "query", + "required": false, + "schema": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "ref", + "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`." + } + }, + { + "name": "state", + "description": "Set to `open`, `fixed`, or `dismissed` to list code scanning alerts in a specific state.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "dismissed", + "fixed" + ] + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": false + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "instances_url": { + "type": "string", + "description": "The REST API URL for fetching the list of instances for an alert.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "dismissed_by": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "dismissed_at": { + "type": "string", + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "dismissed_reason": { + "type": "string", + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "nullable": true, + "oneOf": [ + { + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + }, + { + "enum": [ + null + ] + } + ] + }, + "rule": { + "type": "object", + "properties": { + "id": { + "nullable": true, + "type": "string", + "description": "A unique identifier for the rule used to detect the alert." + }, + "name": { + "type": "string", + "description": "The name of the rule used to detect the alert." + }, + "severity": { + "nullable": true, + "type": "string", + "description": "The severity of the alert.", + "enum": [ + "none", + "note", + "warning", + "error" + ] + }, + "description": { + "type": "string", + "description": "A short description of the rule used to detect the alert." + } + } + }, + "tool": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + }, + "version": { + "nullable": true, + "type": "string", + "description": "The version of the tool used to generate the code scanning analysis." + }, + "guid": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + } + }, + "most_recent_instance": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`." + }, + "analysis_key": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." + }, + "environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "commit_sha": { + "type": "string" + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "location": { + "type": "object", + "description": "Describe a region within a file for the alert.", + "properties": { + "path": { + "type": "string" + }, + "start_line": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "start_column": { + "type": "integer" + }, + "end_column": { + "type": "integer" + } + } + }, + "html_url": { + "type": "string" + }, + "classifications": { + "type": "array", + "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", + "items": { + "type": "string", + "description": "A classification of the file. For example to identify it as generated.", + "nullable": true, + "enum": [ + "source", + "generated", + "test", + "library" ] } + } + } + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "instances_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool", + "most_recent_instance" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "number": 4, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4", + "html_url": "https://github.com/octocat/hello-world/code-scanning/4", + "state": "open", + "dismissed_by": null, + "dismissed_at": null, + "dismissed_reason": null, + "rule": { + "id": "js/zipslip", + "severity": "error", + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" ] }, - "temp_clone_token": { - "type": "string" + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/4/instances" + }, + { + "number": 3, + "created_at": "2020-02-13T12:29:18Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3", + "html_url": "https://github.com/octocat/hello-world/code-scanning/3", + "state": "dismissed", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "rule": { + "id": "js/zipslip", + "severity": "error", + "description": "Arbitrary file write during zip extraction", + "name": "js/zipslip" + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "lib/ab12-gen.js", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/3/instances" + } + ] + } + } + } + } + }, + "403": { + "description": "Response if github advanced security is not enabled for this repository", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service Unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "code-scanning", + "subcategory": null + } + } + }, + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}": { + "get": { + "summary": "Get a code scanning alert", + "description": "Gets a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe instances field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The same information can now be retrieved via a GET request to the URL specified by `instances_url`.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/get-alert", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#get-a-code-scanning-alert" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "alert_number", + "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "required": true, + "schema": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": false + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "instances_url": { + "type": "string", + "description": "The REST API URL for fetching the list of instances for an alert.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "dismissed_by": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" }, - "delete_branch_on_merge": { - "type": "boolean" + "id": { + "type": "integer", + "example": 1 }, - "subscribers_count": { - "type": "integer" + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" }, - "network_count": { - "type": "integer" + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" }, - "license": { - "type": "object", - "properties": { - "key": { - "type": "string" - }, - "name": { - "type": "string" - }, - "spdx_id": { - "type": "string" - }, - "url": { - "type": "string" - }, - "node_id": { - "type": "string" - } - }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", "nullable": true }, - "forks": { - "type": "integer", - "example": 0 + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" }, - "open_issues": { - "type": "integer", - "example": 0 + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" }, - "watchers": { - "type": "integer", - "example": 0 + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" } }, "required": [ - "archive_url", - "assignees_url", - "blobs_url", - "branches_url", - "collaborators_url", - "comments_url", - "commits_url", - "compare_url", - "contents_url", - "contributors_url", - "deployments_url", - "description", - "downloads_url", + "avatar_url", "events_url", - "fork", - "forks_url", - "full_name", - "git_commits_url", - "git_refs_url", - "git_tags_url", - "hooks_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", "html_url", "id", "node_id", - "issue_comment_url", - "issue_events_url", - "issues_url", - "keys_url", - "labels_url", - "languages_url", - "merges_url", - "milestones_url", - "name", - "notifications_url", - "owner", - "private", - "pulls_url", - "releases_url", - "stargazers_url", - "statuses_url", - "subscribers_url", - "subscription_url", - "tags_url", - "teams_url", - "trees_url", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", "url" - ] + ], + "nullable": true }, - "created_at": { + "dismissed_at": { "type": "string", + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", "format": "date-time", + "readOnly": true, "nullable": true }, - "updated_at": { + "dismissed_reason": { "type": "string", - "format": "date-time", - "nullable": true + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "nullable": true, + "oneOf": [ + { + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + }, + { + "enum": [ + null + ] + } + ] }, - "head_commit": { - "title": "Simple Commit", - "description": "Simple Commit", + "rule": { "type": "object", "properties": { "id": { - "type": "string" + "nullable": true, + "type": "string", + "description": "A unique identifier for the rule used to detect the alert." }, - "tree_id": { - "type": "string" + "name": { + "type": "string", + "description": "The name of the rule used to detect the alert." }, - "message": { - "type": "string" + "severity": { + "nullable": true, + "type": "string", + "description": "The severity of the alert.", + "enum": [ + "none", + "note", + "warning", + "error" + ] }, - "timestamp": { + "description": { "type": "string", - "format": "date-time" + "description": "A short description of the rule used to detect the alert." }, - "author": { + "full_description": { + "type": "string", + "description": "description of the rule used to detect the alert." + }, + "tags": { + "type": "array", + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } + }, + "help": { + "type": "string", + "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + } + } + }, + "tool": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + }, + "version": { + "nullable": true, + "type": "string", + "description": "The version of the tool used to generate the code scanning analysis." + }, + "guid": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + } + }, + "most_recent_instance": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`." + }, + "analysis_key": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." + }, + "environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "commit_sha": { + "type": "string" + }, + "message": { "type": "object", "properties": { - "name": { - "type": "string" - }, - "email": { + "text": { "type": "string" } - }, - "required": [ - "name", - "email" - ], - "nullable": true + } }, - "committer": { + "location": { "type": "object", + "description": "Describe a region within a file for the alert.", "properties": { - "name": { + "path": { "type": "string" }, - "email": { - "type": "string" + "start_line": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "start_column": { + "type": "integer" + }, + "end_column": { + "type": "integer" } - }, - "required": [ - "name", - "email" - ], - "nullable": true + } + }, + "html_url": { + "type": "string" + }, + "classifications": { + "type": "array", + "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", + "items": { + "type": "string", + "description": "A classification of the file. For example to identify it as generated.", + "nullable": true, + "enum": [ + "source", + "generated", + "test", + "library" + ] + } } - }, - "required": [ - "id", - "tree_id", - "message", - "timestamp", - "author", - "committer" - ] - }, - "latest_check_runs_count": { - "type": "integer" - }, - "check_runs_url": { - "type": "string" + } } }, "required": [ - "id", - "node_id", - "head_branch", - "status", - "conclusion", - "head_sha", - "url", - "before", - "after", + "number", "created_at", - "updated_at", - "app", - "head_commit", - "repository", - "latest_check_runs_count", - "check_runs_url", - "pull_requests" + "url", + "html_url", + "instances_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool", + "most_recent_instance" ] }, "examples": { "default": { "value": { - "id": 5, - "node_id": "MDEwOkNoZWNrU3VpdGU1", - "head_branch": "master", - "head_sha": "d6fde92930d4715a2b49857d24b940956b26d2d3", - "status": "completed", - "conclusion": "neutral", - "url": "https://api.github.com/repos/github/hello-world/check-suites/5", - "before": "146e867f55c26428e5f9fade55a9bbf5e95a7912", - "after": "d6fde92930d4715a2b49857d24b940956b26d2d3", - "pull_requests": [ + "number": 42, + "created_at": "2020-06-19T11:21:34Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", + "html_url": "https://github.com/octocat/hello-world/code-scanning/42", + "state": "dismissed", + "dismissed_by": { + "login": "octocat", + "id": 54933897, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-02-14T12:29:18Z", + "dismissed_reason": "false positive", + "rule": { + "id": "js/zipslip", + "severity": "error", + "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", + "name": "js/zipslip", + "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "dismissed", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" + } + } + } + } + } + }, + "403": { + "description": "Response if github advanced security is not enabled for this repository", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service Unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ - ], - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "app": { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true + ], + "category": "code-scanning", + "subcategory": null + } + }, + "patch": { + "summary": "Update a code scanning alert", + "description": "Updates the status of a single code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.", + "operationId": "code-scanning/update-alert", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#update-a-code-scanning-alert" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "alert_number", + "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "required": true, + "schema": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "state": { + "description": "Sets the state of the code scanning alert. Can be one of `open` or `dismissed`. You must provide `dismissed_reason` when you set the state to `dismissed`.", + "type": "string", + "enum": [ + "open", + "dismissed" + ] + }, + "dismissed_reason": { + "type": "string", + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "nullable": true, + "oneOf": [ + { + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] + }, + { + "enum": [ + null + ] + } + ] + } + }, + "required": [ + "state" + ] + }, + "example": { + "state": "dismissed", + "dismissed_reason": "false positive" + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "number": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + }, + "created_at": { + "type": "string", + "description": "The time that the alert was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": false + }, + "url": { + "type": "string", + "description": "The REST API URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "html_url": { + "type": "string", + "description": "The GitHub URL of the alert resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "instances_url": { + "type": "string", + "description": "The REST API URL for fetching the list of instances for an alert.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "dismissed_by": { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" + "id": { + "type": "integer", + "example": 1 }, - "events": [ - "push", - "pull_request" - ] + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } }, - "repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World", - "full_name": "octocat/Hello-World", - "template_repository": { - "id": 1296269, - "node_id": "MDEwOlJlcG9zaXRvcnkxMjk2MjY5", - "name": "Hello-World-Template", - "full_name": "octocat/Hello-World-Template", - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false - }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World-Template", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World-Template", - "archive_url": "https://api.github.com/repos/octocat/Hello-World-Template/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World-Template/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World-Template/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World-Template/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World-Template/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World-Template/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World-Template/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World-Template/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World-Template/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World-Template/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World-Template/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World-Template/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World-Template.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World-Template/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World-Template/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World-Template/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World-Template/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World-Template/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World-Template/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World-Template/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World-Template/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World-Template/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World-Template.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World-Template/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World-Template/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World-Template/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World-Template/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World-Template/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World-Template/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World-Template.git", - "mirror_url": "git:git.example.com/octocat/Hello-World-Template", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World-Template/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World-Template", - "homepage": "https://github.com", - "language": null, - "forks": 9, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "watchers": 80, - "size": 108, - "default_branch": "master", - "open_issues": 0, - "open_issues_count": 0, - "is_template": true, - "license": { - "key": "mit", - "name": "MIT License", - "url": "https://api.github.com/licenses/mit", - "spdx_id": "MIT", - "node_id": "MDc6TGljZW5zZW1pdA==", - "html_url": "https://api.github.com/licenses/mit" - }, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true - }, - "allow_rebase_merge": true, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "allow_squash_merge": true, - "delete_branch_on_merge": true, - "allow_merge_commit": true, - "subscribers_count": 42, - "network_count": 0 + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + "dismissed_at": { + "type": "string", + "description": "The time that the alert was dismissed in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": true + }, + "dismissed_reason": { + "type": "string", + "description": "**Required when the state is dismissed.** The reason for dismissing or closing the alert. Can be one of: `false positive`, `won't fix`, and `used in tests`.", + "nullable": true, + "oneOf": [ + { + "enum": [ + "false positive", + "won't fix", + "used in tests" + ] }, - "owner": { - "login": "octocat", - "id": 1, - "node_id": "MDQ6VXNlcjE=", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "url": "https://api.github.com/users/octocat", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "repos_url": "https://api.github.com/users/octocat/repos", - "events_url": "https://api.github.com/users/octocat/events{/privacy}", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": false + { + "enum": [ + null + ] + } + ] + }, + "rule": { + "type": "object", + "properties": { + "id": { + "nullable": true, + "type": "string", + "description": "A unique identifier for the rule used to detect the alert." }, - "private": false, - "html_url": "https://github.com/octocat/Hello-World", - "description": "This your first repo!", - "fork": false, - "url": "https://api.github.com/repos/octocat/Hello-World", - "archive_url": "https://api.github.com/repos/octocat/Hello-World/{archive_format}{/ref}", - "assignees_url": "https://api.github.com/repos/octocat/Hello-World/assignees{/user}", - "blobs_url": "https://api.github.com/repos/octocat/Hello-World/git/blobs{/sha}", - "branches_url": "https://api.github.com/repos/octocat/Hello-World/branches{/branch}", - "collaborators_url": "https://api.github.com/repos/octocat/Hello-World/collaborators{/collaborator}", - "comments_url": "https://api.github.com/repos/octocat/Hello-World/comments{/number}", - "commits_url": "https://api.github.com/repos/octocat/Hello-World/commits{/sha}", - "compare_url": "https://api.github.com/repos/octocat/Hello-World/compare/{base}...{head}", - "contents_url": "https://api.github.com/repos/octocat/Hello-World/contents/{+path}", - "contributors_url": "https://api.github.com/repos/octocat/Hello-World/contributors", - "deployments_url": "https://api.github.com/repos/octocat/Hello-World/deployments", - "downloads_url": "https://api.github.com/repos/octocat/Hello-World/downloads", - "events_url": "https://api.github.com/repos/octocat/Hello-World/events", - "forks_url": "https://api.github.com/repos/octocat/Hello-World/forks", - "git_commits_url": "https://api.github.com/repos/octocat/Hello-World/git/commits{/sha}", - "git_refs_url": "https://api.github.com/repos/octocat/Hello-World/git/refs{/sha}", - "git_tags_url": "https://api.github.com/repos/octocat/Hello-World/git/tags{/sha}", - "git_url": "git:github.com/octocat/Hello-World.git", - "issue_comment_url": "https://api.github.com/repos/octocat/Hello-World/issues/comments{/number}", - "issue_events_url": "https://api.github.com/repos/octocat/Hello-World/issues/events{/number}", - "issues_url": "https://api.github.com/repos/octocat/Hello-World/issues{/number}", - "keys_url": "https://api.github.com/repos/octocat/Hello-World/keys{/key_id}", - "labels_url": "https://api.github.com/repos/octocat/Hello-World/labels{/name}", - "languages_url": "https://api.github.com/repos/octocat/Hello-World/languages", - "merges_url": "https://api.github.com/repos/octocat/Hello-World/merges", - "milestones_url": "https://api.github.com/repos/octocat/Hello-World/milestones{/number}", - "notifications_url": "https://api.github.com/repos/octocat/Hello-World/notifications{?since,all,participating}", - "pulls_url": "https://api.github.com/repos/octocat/Hello-World/pulls{/number}", - "releases_url": "https://api.github.com/repos/octocat/Hello-World/releases{/id}", - "ssh_url": "git@github.com:octocat/Hello-World.git", - "stargazers_url": "https://api.github.com/repos/octocat/Hello-World/stargazers", - "statuses_url": "https://api.github.com/repos/octocat/Hello-World/statuses/{sha}", - "subscribers_url": "https://api.github.com/repos/octocat/Hello-World/subscribers", - "subscription_url": "https://api.github.com/repos/octocat/Hello-World/subscription", - "tags_url": "https://api.github.com/repos/octocat/Hello-World/tags", - "teams_url": "https://api.github.com/repos/octocat/Hello-World/teams", - "trees_url": "https://api.github.com/repos/octocat/Hello-World/git/trees{/sha}", - "clone_url": "https://github.com/octocat/Hello-World.git", - "mirror_url": "git:git.example.com/octocat/Hello-World", - "hooks_url": "https://api.github.com/repos/octocat/Hello-World/hooks", - "svn_url": "https://svn.github.com/octocat/Hello-World", - "homepage": "https://github.com", - "language": null, - "forks_count": 9, - "stargazers_count": 80, - "watchers_count": 80, - "size": 108, - "default_branch": "master", - "open_issues_count": 0, - "is_template": false, - "topics": [ - "octocat", - "atom", - "electron", - "api" - ], - "has_issues": true, - "has_projects": true, - "has_wiki": true, - "has_pages": false, - "has_downloads": true, - "archived": false, - "disabled": false, - "visibility": "public", - "pushed_at": "2011-01-26T19:06:43Z", - "created_at": "2011-01-26T19:01:12Z", - "updated_at": "2011-01-26T19:14:43Z", - "permissions": { - "admin": false, - "push": false, - "pull": true + "name": { + "type": "string", + "description": "The name of the rule used to detect the alert." + }, + "severity": { + "nullable": true, + "type": "string", + "description": "The severity of the alert.", + "enum": [ + "none", + "note", + "warning", + "error" + ] + }, + "description": { + "type": "string", + "description": "A short description of the rule used to detect the alert." + }, + "full_description": { + "type": "string", + "description": "description of the rule used to detect the alert." + }, + "tags": { + "type": "array", + "description": "A set of tags applicable for the rule.", + "items": { + "type": "string" + } }, - "temp_clone_token": "ABTLWHOULUVAXGTRYU7OC2876QJ2O", - "delete_branch_on_merge": true, - "subscribers_count": 42, - "network_count": 0 - }, - "head_commit": { - "id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "tree_id": "7fd1a60b01f91b314f59955a4e4d4e80d8edf11d", - "message": "Merge pull request #6 from Spaceghost/patch-1\n\nNew line at end of file.", - "timestamp": "2016-10-10T00:00:00Z", - "author": { - "name": "The Octocat", - "email": "octocat@nowhere.com" + "help": { + "type": "string", + "description": "Detailed documentation for the rule as GitHub Flavored Markdown." + } + } + }, + "tool": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." }, - "committer": { - "name": "The Octocat", - "email": "octocat@nowhere.com" + "version": { + "nullable": true, + "type": "string", + "description": "The version of the tool used to generate the code scanning analysis." + }, + "guid": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." } - }, - "latest_check_runs_count": 1, - "check_runs_url": "https://api.github.com/repos/octocat/Hello-World/check-suites/5/check-runs" - } - } - } - } - } - } - }, - "x-github": { - "githubCloudOnly": false, - "enabledForGitHubApps": true, - "previews": [ - - ], - "category": "checks", - "subcategory": "suites" - } - } - }, - "/repos/{owner}/{repo}/check-suites/{check_suite_id}/check-runs": { - "get": { - "summary": "List check runs in a check suite", - "description": "**Note:** The Checks API only looks for pushes in the repository where the check suite or check run were created. Pushes to a branch in a forked repository are not detected and return an empty `pull_requests` array.\n\nLists check runs for a check suite using its `id`. GitHub Apps must have the `checks:read` permission on a private repository or pull access to a public repository to get check runs. OAuth Apps and authenticated users must have the `repo` scope to get check runs in a private repository.", - "tags": [ - "checks" - ], - "operationId": "checks/list-for-suite", - "externalDocs": { - "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#list-check-runs-in-a-check-suite" - }, - "parameters": [ - { - "name": "owner", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "repo", - "in": "path", - "required": true, - "schema": { - "type": "string" - } - }, - { - "name": "check_suite_id", - "description": "check_suite_id parameter", - "in": "path", - "required": true, - "schema": { - "type": "integer" - } - }, - { - "name": "check_name", - "description": "Returns check runs with the specified `name`.", - "in": "query", - "required": false, - "schema": { - "type": "string" - } - }, - { - "name": "status", - "description": "Returns check runs with the specified `status`. Can be one of `queued`, `in_progress`, or `completed`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed" - ] - } - }, - { - "name": "filter", - "description": "Filters check runs by their `completed_at` timestamp. Can be one of `latest` (returning the most recent check runs) or `all`.", - "in": "query", - "required": false, - "schema": { - "type": "string", - "enum": [ - "latest", - "all" - ], - "default": "latest" - } - }, - { - "name": "per_page", - "description": "Results per page (max 100).", - "in": "query", - "schema": { - "type": "integer", - "default": 30 - } - }, - { - "name": "page", - "description": "Page number of the results to fetch.", - "in": "query", - "schema": { - "type": "integer", - "default": 1 - } - } - ], - "responses": { - "200": { - "description": "response", - "content": { - "application/json": { - "schema": { - "type": "object", - "required": [ - "total_count", - "check_runs" - ], - "properties": { - "total_count": { - "type": "integer" + } }, - "check_runs": { - "type": "array", - "items": { - "title": "CheckRun", - "description": "A check performed on the code of a given code change", - "type": "object", - "properties": { - "id": { - "description": "The id of the check.", - "example": 21, - "type": "integer" - }, - "head_sha": { - "description": "The SHA of the commit that is being checked.", - "example": "009b8a3a9ccbb128af87f9b1c0f4c62e8a304f6d", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDg6Q2hlY2tSdW40" - }, - "external_id": { - "type": "string", - "example": "42", - "nullable": true - }, - "url": { - "type": "string", - "example": "https://api.github.com/repos/github/hello-world/check-runs/4" - }, - "html_url": { - "type": "string", - "example": "https://github.com/github/hello-world/runs/4", - "nullable": true - }, - "details_url": { - "type": "string", - "example": "https://example.com", - "nullable": true - }, - "status": { - "description": "The phase of the lifecycle that the check is currently in.", - "example": "queued", - "type": "string", - "enum": [ - "queued", - "in_progress", - "completed" - ] - }, - "conclusion": { - "type": "string", - "example": "neutral", - "enum": [ - "success", - "failure", - "neutral", - "cancelled", - "skipped", - "timed_out", - "action_required" - ], - "nullable": true - }, - "started_at": { - "type": "string", - "format": "date-time", - "example": "2018-05-04T01:14:52Z", - "nullable": true - }, - "completed_at": { - "type": "string", - "format": "date-time", - "example": "2018-05-04T01:14:52Z", - "nullable": true - }, - "output": { - "type": "object", - "properties": { - "title": { - "type": "string", - "nullable": true - }, - "summary": { - "type": "string", - "nullable": true - }, - "text": { - "type": "string", - "nullable": true - }, - "annotations_count": { - "type": "integer" - }, - "annotations_url": { - "type": "string", - "format": "uri" - } + "most_recent_instance": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`." + }, + "analysis_key": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." + }, + "environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "dismissed", + "fixed" + ] + }, + "commit_sha": { + "type": "string" + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "location": { + "type": "object", + "description": "Describe a region within a file for the alert.", + "properties": { + "path": { + "type": "string" }, - "required": [ - "title", - "summary", - "text", - "annotations_count", - "annotations_url" - ] - }, - "name": { - "description": "The name of the check.", - "example": "test-coverage", - "type": "string" - }, - "check_suite": { - "type": "object", - "properties": { - "id": { - "type": "integer" - } + "start_line": { + "type": "integer" }, - "required": [ - "id" - ], - "nullable": true - }, - "app": { - "nullable": true, - "allOf": [ - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "owner": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "example": 5, - "type": "integer" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "client_secret": { - "type": "string", - "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - }, - "webhook_secret": { - "type": "string", - "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - }, - "pem": { - "type": "string", - "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ], - "additionalProperties": true - } - ] - }, - "pull_requests": { - "items": { - "title": "Pull Request Minimal", - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "number": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "head": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "name" - ] - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - }, - "base": { - "type": "object", - "properties": { - "ref": { - "type": "string" - }, - "sha": { - "type": "string" - }, - "repo": { - "type": "object", - "properties": { - "id": { - "type": "integer" - }, - "url": { - "type": "string" - }, - "name": { - "type": "string" - } - }, - "required": [ - "id", - "url", - "name" - ] - } - }, - "required": [ - "ref", - "sha", - "repo" - ] - } - }, - "required": [ - "id", - "number", - "url", - "head", - "base" - ] - } - }, - "deployment": { - "title": "Deployment", - "description": "A deployment created as the result of an Actions check run from a workflow that references an environment", - "type": "object", - "properties": { - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/example/deployments/1" - }, - "id": { - "description": "Unique identifier of the deployment", - "example": 42, - "type": "integer" - }, - "node_id": { - "type": "string", - "example": "MDEwOkRlcGxveW1lbnQx" - }, - "task": { - "description": "Parameter to specify a task to execute", - "example": "deploy", - "type": "string" - }, - "original_environment": { - "type": "string", - "example": "staging" - }, - "environment": { - "description": "Name for the target deployment environment.", - "example": "production", - "type": "string" - }, - "description": { - "type": "string", - "example": "Deploy request from hubot", - "nullable": true - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2012-07-20T01:19:13Z" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2012-07-20T01:19:13Z" - }, - "statuses_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/example/deployments/1/statuses" - }, - "repository_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/repos/octocat/example" - }, - "transient_environment": { - "description": "Specifies if the given environment is will no longer exist at some point in the future. Default: false.", - "example": true, - "type": "boolean" - }, - "production_environment": { - "description": "Specifies if the given environment is one that end-users directly interact with. Default: false.", - "example": true, - "type": "boolean" - }, - "performed_via_github_app": { - "nullable": true, - "allOf": [ - { - "title": "GitHub app", - "description": "GitHub apps are a new way to extend GitHub. They can be installed directly on organizations and user accounts and granted access to specific repositories. They come with granular permissions and built-in webhooks. GitHub apps are first class actors within GitHub.", - "type": "object", - "properties": { - "id": { - "description": "Unique identifier of the GitHub app", - "example": 37, - "type": "integer" - }, - "slug": { - "description": "The slug name of the GitHub app", - "example": "probot-owners", - "type": "string" - }, - "node_id": { - "type": "string", - "example": "MDExOkludGVncmF0aW9uMQ==" - }, - "owner": { - "nullable": true, - "allOf": [ - { - "title": "Simple User", - "description": "Simple User", - "type": "object", - "properties": { - "login": { - "type": "string", - "example": "octocat" - }, - "id": { - "type": "integer", - "example": 1 - }, - "node_id": { - "type": "string", - "example": "MDQ6VXNlcjE=" - }, - "avatar_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/images/error/octocat_happy.gif" - }, - "gravatar_id": { - "type": "string", - "example": "41d064eb2195891e12d0413f63227ea7", - "nullable": true - }, - "url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/octocat" - }, - "followers_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/followers" - }, - "following_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/following{/other_user}" - }, - "gists_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/gists{/gist_id}" - }, - "starred_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" - }, - "subscriptions_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/subscriptions" - }, - "organizations_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/orgs" - }, - "repos_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/repos" - }, - "events_url": { - "type": "string", - "example": "https://api.github.com/users/octocat/events{/privacy}" - }, - "received_events_url": { - "type": "string", - "format": "uri", - "example": "https://api.github.com/users/octocat/received_events" - }, - "type": { - "type": "string", - "example": "User" - }, - "site_admin": { - "type": "boolean" - }, - "starred_at": { - "type": "string", - "example": "\"2020-07-09T00:17:55Z\"" - } - }, - "required": [ - "avatar_url", - "events_url", - "followers_url", - "following_url", - "gists_url", - "gravatar_id", - "html_url", - "id", - "node_id", - "login", - "organizations_url", - "received_events_url", - "repos_url", - "site_admin", - "starred_url", - "subscriptions_url", - "type", - "url" - ], - "nullable": true - } - ] - }, - "name": { - "description": "The name of the GitHub app", - "example": "Probot Owners", - "type": "string" - }, - "description": { - "type": "string", - "example": "The description of the app.", - "nullable": true - }, - "external_url": { - "type": "string", - "format": "uri", - "example": "https://example.com" - }, - "html_url": { - "type": "string", - "format": "uri", - "example": "https://github.com/apps/super-ci" - }, - "created_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "updated_at": { - "type": "string", - "format": "date-time", - "example": "2017-07-08T16:18:44-04:00" - }, - "permissions": { - "description": "The set of permissions for the GitHub app", - "type": "object", - "properties": { - "issues": { - "type": "string" - }, - "checks": { - "type": "string" - }, - "metadata": { - "type": "string" - }, - "contents": { - "type": "string" - }, - "deployments": { - "type": "string" - } - }, - "additionalProperties": { - "type": "string" - }, - "example": { - "issues": "read", - "deployments": "write" - } - }, - "events": { - "description": "The list of events for the GitHub app", - "example": [ - "label", - "deployment" - ], - "type": "array", - "items": { - "type": "string" - } - }, - "installations_count": { - "description": "The number of installations associated with the GitHub app", - "example": 5, - "type": "integer" - }, - "client_id": { - "type": "string", - "example": "\"Iv1.25b5d1e65ffc4022\"" - }, - "client_secret": { - "type": "string", - "example": "\"1d4b2097ac622ba702d19de498f005747a8b21d3\"" - }, - "webhook_secret": { - "type": "string", - "example": "\"6fba8f2fc8a7e8f2cca5577eddd82ca7586b3b6b\"" - }, - "pem": { - "type": "string", - "example": "\"-----BEGIN RSA PRIVATE KEY-----\\nMIIEogIBAAKCAQEArYxrNYD/iT5CZVpRJu4rBKmmze3PVmT/gCo2ATUvDvZTPTey\\nxcGJ3vvrJXazKk06pN05TN29o98jrYz4cengG3YGsXPNEpKsIrEl8NhbnxapEnM9\\nJCMRe0P5JcPsfZlX6hmiT7136GRWiGOUba2X9+HKh8QJVLG5rM007TBER9/z9mWm\\nrJuNh+m5l320oBQY/Qq3A7wzdEfZw8qm/mIN0FCeoXH1L6B8xXWaAYBwhTEh6SSn\\nZHlO1Xu1JWDmAvBCi0RO5aRSKM8q9QEkvvHP4yweAtK3N8+aAbZ7ovaDhyGz8r6r\\nzhU1b8Uo0Z2ysf503WqzQgIajr7Fry7/kUwpgQIDAQABAoIBADwJp80Ko1xHPZDy\\nfcCKBDfIuPvkmSW6KumbsLMaQv1aGdHDwwTGv3t0ixSay8CGlxMRtRDyZPib6SvQ\\n6OH/lpfpbMdW2ErkksgtoIKBVrDilfrcAvrNZu7NxRNbhCSvN8q0s4ICecjbbVQh\\nnueSdlA6vGXbW58BHMq68uRbHkP+k+mM9U0mDJ1HMch67wlg5GbayVRt63H7R2+r\\nVxcna7B80J/lCEjIYZznawgiTvp3MSanTglqAYi+m1EcSsP14bJIB9vgaxS79kTu\\noiSo93leJbBvuGo8QEiUqTwMw4tDksmkLsoqNKQ1q9P7LZ9DGcujtPy4EZsamSJT\\ny8OJt0ECgYEA2lxOxJsQk2kI325JgKFjo92mQeUObIvPfSNWUIZQDTjniOI6Gv63\\nGLWVFrZcvQBWjMEQraJA9xjPbblV8PtfO87MiJGLWCHFxmPz2dzoedN+2Coxom8m\\nV95CLz8QUShuao6u/RYcvUaZEoYs5bHcTmy5sBK80JyEmafJPtCQVxMCgYEAy3ar\\nZr3yv4xRPEPMat4rseswmuMooSaK3SKub19WFI5IAtB/e7qR1Rj9JhOGcZz+OQrl\\nT78O2OFYlgOIkJPvRMrPpK5V9lslc7tz1FSh3BZMRGq5jSyD7ETSOQ0c8T2O/s7v\\nbeEPbVbDe4mwvM24XByH0GnWveVxaDl51ABD65sCgYB3ZAspUkOA5egVCh8kNpnd\\nSd6SnuQBE3ySRlT2WEnCwP9Ph6oPgn+oAfiPX4xbRqkL8q/k0BdHQ4h+zNwhk7+h\\nWtPYRAP1Xxnc/F+jGjb+DVaIaKGU18MWPg7f+FI6nampl3Q0KvfxwX0GdNhtio8T\\nTj1E+SnFwh56SRQuxSh2gwKBgHKjlIO5NtNSflsUYFM+hyQiPiqnHzddfhSG+/3o\\nm5nNaSmczJesUYreH5San7/YEy2UxAugvP7aSY2MxB+iGsiJ9WD2kZzTUlDZJ7RV\\nUzWsoqBR+eZfVJ2FUWWvy8TpSG6trh4dFxImNtKejCR1TREpSiTV3Zb1dmahK9GV\\nrK9NAoGAbBxRLoC01xfxCTgt5BDiBcFVh4fp5yYKwavJPLzHSpuDOrrI9jDn1oKN\\nonq5sDU1i391zfQvdrbX4Ova48BN+B7p63FocP/MK5tyyBoT8zQEk2+vWDOw7H/Z\\nu5dTCPxTIsoIwUw1I+7yIxqJzLPFgR2gVBwY1ra/8iAqCj+zeBw=\\n-----END RSA PRIVATE KEY-----\\n\"" - } - }, - "required": [ - "id", - "node_id", - "owner", - "name", - "description", - "external_url", - "html_url", - "created_at", - "updated_at", - "permissions", - "events" - ], - "additionalProperties": true - } - ] - } + "end_line": { + "type": "integer" }, - "required": [ - "id", - "node_id", - "task", - "environment", - "description", - "statuses_url", - "repository_url", - "url", - "created_at", - "updated_at" + "start_column": { + "type": "integer" + }, + "end_column": { + "type": "integer" + } + } + }, + "html_url": { + "type": "string" + }, + "classifications": { + "type": "array", + "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", + "items": { + "type": "string", + "description": "A classification of the file. For example to identify it as generated.", + "nullable": true, + "enum": [ + "source", + "generated", + "test", + "library" ] } + } + } + } + }, + "required": [ + "number", + "created_at", + "url", + "html_url", + "instances_url", + "state", + "dismissed_by", + "dismissed_at", + "dismissed_reason", + "rule", + "tool", + "most_recent_instance" + ] + }, + "examples": { + "default": { + "value": { + "number": 42, + "created_at": "2020-08-25T21:28:36Z", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42", + "html_url": "https://github.com/octocat/hello-world/code-scanning/42", + "state": "dismissed", + "dismissed_by": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + }, + "dismissed_at": "2020-09-02T22:34:56Z", + "dismissed_reason": "false positive", + "rule": { + "id": "js/zipslip", + "severity": "error", + "description": "Arbitrary file write during zip extraction (\"Zip Slip\")", + "name": "js/zipslip", + "full_description": "Extracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten.", + "tags": [ + "security", + "external/cwe/cwe-022" + ], + "help": "# Arbitrary file write during zip extraction (\"Zip Slip\")\\nExtracting files from a malicious zip archive without validating that the destination file path is within the destination directory can cause files outside the destination directory to be overwritten ..." + }, + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "most_recent_instance": { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "{}", + "state": "dismissed", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." }, - "required": [ - "id", - "node_id", - "head_sha", - "name", - "url", - "html_url", - "details_url", - "status", - "conclusion", - "started_at", - "completed_at", - "external_id", - "check_suite", - "output", - "app", - "pull_requests" + "location": { + "path": "spec-main/api-session-spec.ts", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "test" + ] + }, + "instances_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/alerts/42/instances" + } + } + } + } + } + }, + "403": { + "description": "Response if the repository is archived or if github advanced security is not enabled for this repository", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service Unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/alerts/{alert_number}/instances": { + "get": { + "summary": "List instances of a code scanning alert", + "description": "Lists all instances of the specified code scanning alert. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", + "tags": [ + "code-scanning" + ], + "operationId": "code-scanning/list-alerts-instances", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#list-instances-of-a-code-scanning-alert" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "alert_number", + "in": "path", + "description": "The number that identifies an alert. You can find this at the end of the URL for a code scanning alert within GitHub, and in the `number` field in the response from the `GET /repos/{owner}/{repo}/code-scanning/alerts` operation.", + "required": true, + "schema": { + "type": "integer", + "description": "The security alert number.", + "readOnly": true, + "nullable": false + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "ref", + "description": "The Git reference for the results you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`." + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`." + }, + "analysis_key": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." + }, + "environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which the analysis that generated this alert instance was performed, such as the language that was analyzed." + }, + "state": { + "type": "string", + "description": "State of a code scanning alert.", + "enum": [ + "open", + "dismissed", + "fixed" ] + }, + "commit_sha": { + "type": "string" + }, + "message": { + "type": "object", + "properties": { + "text": { + "type": "string" + } + } + }, + "location": { + "type": "object", + "description": "Describe a region within a file for the alert.", + "properties": { + "path": { + "type": "string" + }, + "start_line": { + "type": "integer" + }, + "end_line": { + "type": "integer" + }, + "start_column": { + "type": "integer" + }, + "end_column": { + "type": "integer" + } + } + }, + "html_url": { + "type": "string" + }, + "classifications": { + "type": "array", + "description": "Classifications that have been applied to the file that triggered the alert.\nFor example identifying it as documentation, or a generated file.", + "items": { + "type": "string", + "description": "A classification of the file. For example to identify it as generated.", + "nullable": true, + "enum": [ + "source", + "generated", + "test", + "library" + ] + } } } } }, "examples": { "default": { - "value": { - "total_count": 1, - "check_runs": [ - { - "id": 4, - "head_sha": "ce587453ced02b1526dfb4cb910479d431683101", - "node_id": "MDg6Q2hlY2tSdW40", - "external_id": "", - "url": "https://api.github.com/repos/github/hello-world/check-runs/4", - "html_url": "https://github.com/github/hello-world/runs/4", - "details_url": "https://example.com", - "status": "completed", - "conclusion": "neutral", - "started_at": "2018-05-04T01:14:52Z", - "completed_at": "2018-05-04T01:14:52Z", - "output": { - "title": "Mighty Readme report", - "summary": "There are 0 failures, 2 warnings, and 1 notice.", - "text": "You may have some misspelled words on lines 2 and 4. You also may want to add a section in your README about how to install your app.", - "annotations_count": 2, - "annotations_url": "https://api.github.com/repos/github/hello-world/check-runs/4/annotations" - }, - "name": "mighty_readme", - "check_suite": { - "id": 5 + "value": [ + { + "ref": "refs/heads/main", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "", + "state": "open", + "commit_sha": "39406e42cb832f683daa691dd652a8dc36ee8930", + "message": { + "text": "This path depends on a user-provided value." + }, + "location": { + "path": "lib/ab12-gen.js", + "start_line": 917, + "end_line": 917, + "start_column": 7, + "end_column": 18 + }, + "classifications": [ + "library" + ] + }, + { + "ref": "refs/pull/3740/merge", + "analysis_key": ".github/workflows/codeql-analysis.yml:CodeQL-Build", + "environment": "", + "state": "fixed", + "commit_sha": "b09da05606e27f463a2b49287684b4ae777092f2", + "message": { + "text": "This suffix check is missing a length comparison to correctly handle lastIndexOf returning -1." + }, + "location": { + "path": "app/script.js", + "start_line": 2, + "end_line": 2, + "start_column": 10, + "end_column": 50 + }, + "classifications": [ + "source" + ] + } + ] + } + } + } + } + }, + "403": { + "description": "Response if github advanced security is not enabled for this repository", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service Unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "code-scanning", + "subcategory": null + } + } + }, + "/repos/{owner}/{repo}/code-scanning/analyses": { + "get": { + "summary": "List code scanning analyses for a repository", + "description": "Lists the details of all code scanning analyses for a repository,\nstarting with the most recent.\nThe response is paginated and you can use the `page` and `per_page` parameters\nto list the analyses you're interested in.\nBy default 30 analyses are listed per page.\n\nThe `rules_count` field in the response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", + "operationId": "code-scanning/list-recent-analyses", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#list-code-scanning-analyses-for-a-repository" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "tool_name", + "description": "The name of a code scanning tool. Only results by this tool will be listed. You can specify the tool by using either `tool_name` or `tool_guid`, but not both.", + "in": "query", + "required": false, + "schema": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + } + }, + { + "name": "tool_guid", + "description": "The GUID of a code scanning tool. Only results by this tool will be listed. Note that some code scanning tools may not include a GUID in their analysis data. You can specify the tool by using either `tool_guid` or `tool_name`, but not both.", + "in": "query", + "required": false, + "schema": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "ref", + "in": "query", + "description": "The Git reference for the analyses you want to list. The `ref` for a branch can be formatted either as `refs/heads/` or simply ``. To reference a pull request use `refs/pull//merge`.", + "required": false, + "schema": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`." + } + }, + { + "name": "sarif_id", + "in": "query", + "description": "Filter analyses belonging to the same SARIF upload.", + "required": false, + "schema": { + "type": "string", + "description": "An identifier for the upload.", + "example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53", + "nullable": false + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "array", + "items": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`." + }, + "commit_sha": { + "description": "The SHA of the commit to which the analysis you are uploading relates.", + "type": "string", + "minLength": 40, + "maxLength": 40, + "pattern": "^[0-9a-fA-F]+$" + }, + "analysis_key": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." + }, + "environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which this analysis was performed." + }, + "error": { + "type": "string", + "example": "error reading field xyz" + }, + "created_at": { + "type": "string", + "description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": false + }, + "results_count": { + "type": "integer", + "description": "The total number of results in the analysis." + }, + "rules_count": { + "type": "integer", + "description": "The total number of rules used in the analysis." + }, + "id": { + "type": "integer", + "description": "Unique identifier for this analysis." + }, + "url": { + "type": "string", + "description": "The REST API URL of the analysis resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "sarif_id": { + "type": "string", + "description": "An identifier for the upload.", + "example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53", + "nullable": false + }, + "tool": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." }, - "app": { - "id": 1, - "slug": "octoapp", - "node_id": "MDExOkludGVncmF0aW9uMQ==", - "owner": { - "login": "github", - "id": 1, - "node_id": "MDEyOk9yZ2FuaXphdGlvbjE=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "avatar_url": "https://github.com/images/error/octocat_happy.gif", - "gravatar_id": "", - "html_url": "https://github.com/octocat", - "followers_url": "https://api.github.com/users/octocat/followers", - "following_url": "https://api.github.com/users/octocat/following{/other_user}", - "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", - "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", - "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", - "organizations_url": "https://api.github.com/users/octocat/orgs", - "received_events_url": "https://api.github.com/users/octocat/received_events", - "type": "User", - "site_admin": true - }, - "name": "Octocat App", - "description": "", - "external_url": "https://example.com", - "html_url": "https://github.com/apps/octoapp", - "created_at": "2017-07-08T16:18:44-04:00", - "updated_at": "2017-07-08T16:18:44-04:00", - "permissions": { - "metadata": "read", - "contents": "read", - "issues": "write", - "single_file": "write" - }, - "events": [ - "push", - "pull_request" - ] + "version": { + "nullable": true, + "type": "string", + "description": "The version of the tool used to generate the code scanning analysis." }, - "pull_requests": [ - { - "url": "https://api.github.com/repos/github/hello-world/pulls/1", - "id": 1934, - "number": 3956, - "head": { - "ref": "say-hello", - "sha": "3dca65fa3e8d4b3da3f3d056c59aee1c50f41390", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - }, - "base": { - "ref": "master", - "sha": "e7fdf7640066d71ad16a86fbcbb9c6a10a18af4f", - "repo": { - "id": 526, - "url": "https://api.github.com/repos/github/hello-world", - "name": "hello-world" - } - } - } - ] + "guid": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } } - ] + }, + "deletable": { + "type": "boolean" + } + }, + "required": [ + "ref", + "commit_sha", + "analysis_key", + "environment", + "error", + "created_at", + "results_count", + "rules_count", + "id", + "url", + "sarif_id", + "tool", + "deletable" + ] + } + }, + "examples": { + "default": { + "value": [ + { + "ref": "refs/heads/main", + "commit_sha": "d99612c3e1f2970085cfbaeadf8f010ef69bad83", + "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", + "environment": "{\"language\":\"python\"}", + "error": "", + "created_at": "2020-08-27T15:05:21Z", + "results_count": 17, + "rules_count": 49, + "id": 201, + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201", + "sarif_id": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53", + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "deletable": true + }, + { + "ref": "refs/heads/my-branch", + "commit_sha": "c8cff6510d4d084fb1b4aa13b64b97ca12b07321", + "analysis_key": ".github/workflows/shiftleft.yml:build", + "environment": "{}", + "error": "", + "created_at": "2020-08-31T22:46:44Z", + "results_count": 17, + "rules_count": 32, + "id": 200, + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/200", + "sarif_id": "8981cd8e-b078-4ac3-a3be-1dad7dbd0b582", + "tool": { + "name": "Python Security Analysis", + "guid": null, + "version": "1.2.0" + }, + "deletable": true + } + ] + } + } + } + } + }, + "403": { + "description": "Response if github advanced security is not enabled for this repository", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" } } } } - }, - "headers": { - "Link": { - "example": "; rel=\"next\", ; rel=\"last\"", + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { "schema": { - "type": "string" + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service Unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } } } } } }, "x-github": { - "githubCloudOnly": false, "enabledForGitHubApps": true, + "githubCloudOnly": false, "previews": [ ], - "category": "checks", - "subcategory": "runs" + "category": "code-scanning" } } }, - "/repos/{owner}/{repo}/check-suites/{check_suite_id}/rerequest": { - "post": { - "summary": "Rerequest a check suite", - "description": "Triggers GitHub to rerequest an existing check suite, without pushing new code to a repository. This endpoint will trigger the [`check_suite` webhook](https://docs.github.com/github-ae@latest/webhooks/event-payloads/#check_suite) event with the action `rerequested`. When a check suite is `rerequested`, its `status` is reset to `queued` and the `conclusion` is cleared.\n\nTo rerequest a check suite, your GitHub App must have the `checks:read` permission on a private repository or pull access to a public repository.", + "/repos/{owner}/{repo}/code-scanning/analyses/{analysis_id}": { + "get": { + "summary": "Get a code scanning analysis for a repository", + "description": "Gets a specified code scanning analysis for a repository.\nYou must use an access token with the `security_events` scope to use this endpoint.\nGitHub Apps must have the `security_events` read permission to use this endpoint.\n\nThe default JSON response contains fields that describe the analysis.\nThis includes the Git reference and commit SHA to which the analysis relates,\nthe datetime of the analysis, the name of the code scanning tool,\nand the number of alerts.\n\nThe `rules_count` field in the default response give the number of rules\nthat were run in the analysis.\nFor very old analyses this data is not available,\nand `0` is returned in this field.\n\nIf you use the Accept header `application/sarif+json`,\nthe response contains the analysis data that was uploaded.\nThis is formatted as\n[SARIF version 2.1.0](https://docs.oasis-open.org/sarif/sarif/v2.1.0/cs01/sarif-v2.1.0-cs01.html).\nFor an example response, see \"[Custom media type for code scanning](#custom-media-type-for-code-scanning).\"\n\n**Deprecation notice**:\nThe `tool_name` field is deprecated and will, in future, not be included in the response for this endpoint. The example response reflects this change. The tool name can now be found inside the `tool` field.", + "operationId": "code-scanning/get-analysis", "tags": [ - "checks" + "code-scanning" ], - "operationId": "checks/rerequest-suite", "externalDocs": { "description": "API method documentation", - "url": "https://docs.github.com/github-ae@latest/rest/reference/checks#rerequest-a-check-suite" + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository" }, "parameters": [ { @@ -98173,9 +122407,9 @@ } }, { - "name": "check_suite_id", - "description": "check_suite_id parameter", + "name": "analysis_id", "in": "path", + "description": "The ID of the analysis, as returned from the `GET /repos/{owner}/{repo}/code-scanning/analyses` operation.", "required": true, "schema": { "type": "integer" @@ -98183,18 +122417,523 @@ } ], "responses": { - "201": { - "description": "response" + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`." + }, + "commit_sha": { + "description": "The SHA of the commit to which the analysis you are uploading relates.", + "type": "string", + "minLength": 40, + "maxLength": 40, + "pattern": "^[0-9a-fA-F]+$" + }, + "analysis_key": { + "type": "string", + "description": "Identifies the configuration under which the analysis was executed. For example, in GitHub Actions this includes the workflow filename and job name." + }, + "environment": { + "type": "string", + "description": "Identifies the variable values associated with the environment in which this analysis was performed." + }, + "error": { + "type": "string", + "example": "error reading field xyz" + }, + "created_at": { + "type": "string", + "description": "The time that the analysis was created in ISO 8601 format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date-time", + "readOnly": true, + "nullable": false + }, + "results_count": { + "type": "integer", + "description": "The total number of results in the analysis." + }, + "rules_count": { + "type": "integer", + "description": "The total number of rules used in the analysis." + }, + "id": { + "type": "integer", + "description": "Unique identifier for this analysis." + }, + "url": { + "type": "string", + "description": "The REST API URL of the analysis resource.", + "format": "uri", + "readOnly": true, + "nullable": false + }, + "sarif_id": { + "type": "string", + "description": "An identifier for the upload.", + "example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53", + "nullable": false + }, + "tool": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the tool used to generate the code scanning analysis." + }, + "version": { + "nullable": true, + "type": "string", + "description": "The version of the tool used to generate the code scanning analysis." + }, + "guid": { + "nullable": true, + "type": "string", + "description": "The GUID of the tool used to generate the code scanning analysis, if provided in the uploaded SARIF data." + } + } + }, + "deletable": { + "type": "boolean" + } + }, + "required": [ + "ref", + "commit_sha", + "analysis_key", + "environment", + "error", + "created_at", + "results_count", + "rules_count", + "id", + "url", + "sarif_id", + "tool", + "deletable" + ] + }, + "examples": { + "response": { + "summary": "Default response", + "value": { + "ref": "refs/heads/main", + "commit_sha": "c18c69115654ff0166991962832dc2bd7756e655", + "analysis_key": ".github/workflows/codeql-analysis.yml:analyze", + "environment": "{\"language\":\"javascript\"}", + "error": "", + "created_at": "2021-01-13T11:55:49Z", + "results_count": 3, + "rules_count": 67, + "id": 3602840, + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses/201", + "sarif_id": "47177e22-5596-11eb-80a1-c1e54ef945c6", + "tool": { + "name": "CodeQL", + "guid": null, + "version": "2.4.0" + }, + "deletable": true + } + } + } + } + } + }, + "403": { + "description": "Response if github advanced security is not enabled for this repository", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "503": { + "description": "Service Unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "enabledForGitHubApps": true, + "githubCloudOnly": false, + "previews": [ + + ], + "category": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/sarifs": { + "post": { + "summary": "Upload an analysis as SARIF data", + "description": "Uploads SARIF data containing the results of a code scanning analysis to make the results available in a repository. You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` write permission to use this endpoint.\n\nYou must compress the SARIF-formatted analysis data that you want to upload, using `gzip`, and then encode it as a Base64 format string. For example:\n\n```\ngzip -c analysis-data.sarif | base64\n```\n\nSARIF upload supports a maximum of 1000 results per analysis run. Any results over this limit are ignored. Typically, but not necessarily, a SARIF file contains a single run of a single tool. If a code scanning tool generates too many results, you should update the analysis configuration to run only the most important rules or queries.\n\nThe `202 Accepted`, response includes an `id` value.\nYou can use this ID to check the status of the upload by using this for the `/sarifs/{sarif_id}` endpoint.\nFor more information, see \"[Get information about a SARIF upload](/rest/reference/code-scanning#get-information-about-a-sarif-upload).\"", + "operationId": "code-scanning/upload-sarif", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#upload-an-analysis-as-sarif-data" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "commit_sha": { + "description": "The SHA of the commit to which the analysis you are uploading relates.", + "type": "string", + "minLength": 40, + "maxLength": 40, + "pattern": "^[0-9a-fA-F]+$" + }, + "ref": { + "type": "string", + "description": "The full Git reference, formatted as `refs/heads/`." + }, + "sarif": { + "description": "A Base64 string representing the SARIF file to upload. You must first compress your SARIF file using [`gzip`](http://www.gnu.org/software/gzip/manual/gzip.html) and then translate the contents of the file into a Base64 encoding string. For more information, see \"[SARIF support for code scanning](https://docs.github.com/github-ae@latest/github/finding-security-vulnerabilities-and-errors-in-your-code/sarif-support-for-code-scanning).\"", + "type": "string" + }, + "checkout_uri": { + "description": "The base directory used in the analysis, as it appears in the SARIF file.\nThis property is used to convert file paths from absolute to relative, so that alerts can be mapped to their correct location in the repository.", + "example": "file:///github/workspace/", + "type": "string", + "format": "uri" + }, + "started_at": { + "description": "The time that the analysis run began. This is a timestamp in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format: `YYYY-MM-DDTHH:MM:SSZ`.", + "format": "date", + "type": "string" + }, + "tool_name": { + "description": "The name of the tool used to generate the code scanning analysis. If this parameter is not used, the tool name defaults to \"API\". If the uploaded SARIF contains a tool GUID, this will be available for filtering using the `tool_guid` parameter of operations such as `GET /repos/{owner}/{repo}/code-scanning/alerts`.", + "type": "string" + } + }, + "required": [ + "commit_sha", + "ref", + "sarif" + ] + } + } + } + }, + "responses": { + "202": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "An identifier for the upload.", + "example": "6c81cd8e-b078-4ac3-a3be-1dad7dbd0b53", + "nullable": false + }, + "url": { + "type": "string", + "description": "The REST API URL for checking the status of the upload.", + "format": "uri", + "readOnly": true, + "nullable": false + } + } + }, + "examples": { + "default": { + "summary": "Default response", + "value": { + "id": "47177e22-5596-11eb-80a1-c1e54ef945c6", + "url": "https://api.github.com/repos/octocat/hello-world/code-scanning/sarifs/47177e22-5596-11eb-80a1-c1e54ef945c6" + } + } + } + } + } + }, + "400": { + "description": "Response if the sarif field is invalid" + }, + "403": { + "description": "Response if the repository is archived or if github advanced security is not enabled for this repository", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Resource Not Found", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "413": { + "description": "Response if the sarif field is too large" + }, + "503": { + "description": "Service Unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } } }, "x-github": { + "enabledForGitHubApps": true, "githubCloudOnly": false, + "previews": [ + + ], + "category": "code-scanning" + } + } + }, + "/repos/{owner}/{repo}/code-scanning/sarifs/{sarif_id}": { + "get": { + "summary": "Get information about a SARIF upload", + "description": "Gets information about a SARIF upload, including the status and the URL of the analysis that was uploaded so that you can retrieve details of the analysis. For more information, see \"[Get a code scanning analysis for a repository](/rest/reference/code-scanning#get-a-code-scanning-analysis-for-a-repository).\" You must use an access token with the `security_events` scope to use this endpoint. GitHub Apps must have the `security_events` read permission to use this endpoint.", + "operationId": "code-scanning/get-sarif", + "tags": [ + "code-scanning" + ], + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/code-scanning#get-information-about-a-sarif-upload" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "sarif_id", + "description": "The SARIF ID obtained after uploading.", + "in": "path", + "schema": { + "type": "string" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "processing_status": { + "type": "string", + "enum": [ + "pending", + "complete" + ], + "description": "`pending` files have not yet been processed, while `complete` means all results in the SARIF have been stored." + }, + "analyses_url": { + "type": "string", + "description": "The REST API URL for getting the analyses associated with the upload.", + "format": "uri", + "readOnly": true, + "nullable": true + } + } + }, + "examples": { + "default": { + "summary": "Default response", + "value": { + "processing_status": "complete", + "analyses_url": "https://api.github.com/repos/octocat/hello-world/code-scanning/analyses?sarif_id=47177e22-5596-11eb-80a1-c1e54ef945c6" + } + } + } + } + } + }, + "403": { + "description": "Response if github advanced security is not enabled for this repository", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + }, + "404": { + "description": "Response if the sarif id does not match any upload" + }, + "503": { + "description": "Service Unavailable", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { "enabledForGitHubApps": true, + "githubCloudOnly": false, "previews": [ ], - "category": "checks", - "subcategory": "suites" + "category": "code-scanning" } } }, @@ -123271,6 +148010,1632 @@ } } }, + "/repos/{owner}/{repo}/environments": { + "get": { + "summary": "Get all environments", + "description": "Get all environments for a repository.\n\nAnyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/get-all-environments", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#get-all-environments" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "total_count": { + "description": "The number of environments in this repository", + "example": 5, + "type": "integer" + }, + "environments": { + "type": "array", + "items": { + "title": "Environment", + "description": "Details of a deployment environment", + "type": "object", + "properties": { + "id": { + "description": "The id of the environment.", + "example": 56780428, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=" + }, + "name": { + "description": "The name of the environment.", + "example": "staging", + "type": "string" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/environments/staging" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" + }, + "created_at": { + "description": "The time that the environment was created, in ISO 8601 format.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string" + }, + "updated_at": { + "description": "The time that the environment was last updated, in ISO 8601 format.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string" + }, + "protection_rules": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3515 + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM1MTU=" + }, + "type": { + "type": "string", + "example": "wait_timer" + }, + "wait_timer": { + "type": "integer", + "example": 30, + "description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days)." + } + }, + "required": [ + "id", + "node_id", + "type" + ] + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3755 + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM3NTU=" + }, + "type": { + "type": "string", + "example": "required_reviewers" + }, + "reviewers": { + "type": "array", + "description": "The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of reviewer. Must be one of: `User` or `Team`", + "enum": [ + "User", + "Team" + ], + "example": "User" + }, + "reviewer": { + "anyOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + ] + } + } + } + } + }, + "required": [ + "id", + "node_id", + "type" + ] + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3515 + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM1MTU=" + }, + "type": { + "type": "string", + "example": "branch_policy" + } + }, + "required": [ + "id", + "node_id", + "type" + ] + } + ] + } + }, + "deployment_branch_policy": { + "type": "object", + "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", + "properties": { + "protected_branches": { + "type": "boolean", + "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`." + }, + "custom_branch_policies": { + "type": "boolean", + "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`." + } + }, + "nullable": true, + "required": [ + "protected_branches", + "custom_branch_policies" + ] + } + }, + "required": [ + "id", + "node_id", + "name", + "url", + "html_url", + "created_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 1, + "environments": [ + { + "id": 161088068, + "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", + "name": "staging", + "url": "https://api.github.com/repos/github/hello-world/environments/staging", + "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging", + "created_at": "2020-11-23T22:00:40Z", + "updated_at": "2020-11-23T22:00:40Z", + "protection_rules": [ + { + "id": 3736, + "node_id": "MDQ6R2F0ZTM3MzY=", + "type": "wait_timer", + "wait_timer": 30 + }, + { + "id": 3755, + "node_id": "MDQ6R2F0ZTM3NTU=", + "type": "required_reviewers", + "reviewers": [ + { + "type": "User", + "reviewer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + { + "type": "Team", + "reviewer": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos" + } + } + ] + }, + { + "id": 3756, + "node_id": "MDQ6R2F0ZTM3NTY=", + "type": "branch_policy" + } + ], + "deployment_branch_policy": { + "protected_branches": false, + "custom_branch_policies": true + } + } + ] + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "environments" + } + } + }, + "/repos/{owner}/{repo}/environments/{environment_name}": { + "get": { + "summary": "Get an environment", + "description": "Anyone with read access to the repository can use this endpoint. If the repository is private, you must use an access token with the `repo` scope. GitHub Apps must have the `actions:read` permission to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/get-environment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#get-an-environment" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Environment", + "description": "Details of a deployment environment", + "type": "object", + "properties": { + "id": { + "description": "The id of the environment.", + "example": 56780428, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=" + }, + "name": { + "description": "The name of the environment.", + "example": "staging", + "type": "string" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/environments/staging" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" + }, + "created_at": { + "description": "The time that the environment was created, in ISO 8601 format.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string" + }, + "updated_at": { + "description": "The time that the environment was last updated, in ISO 8601 format.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string" + }, + "protection_rules": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3515 + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM1MTU=" + }, + "type": { + "type": "string", + "example": "wait_timer" + }, + "wait_timer": { + "type": "integer", + "example": 30, + "description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days)." + } + }, + "required": [ + "id", + "node_id", + "type" + ] + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3755 + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM3NTU=" + }, + "type": { + "type": "string", + "example": "required_reviewers" + }, + "reviewers": { + "type": "array", + "description": "The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of reviewer. Must be one of: `User` or `Team`", + "enum": [ + "User", + "Team" + ], + "example": "User" + }, + "reviewer": { + "anyOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + ] + } + } + } + } + }, + "required": [ + "id", + "node_id", + "type" + ] + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3515 + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM1MTU=" + }, + "type": { + "type": "string", + "example": "branch_policy" + } + }, + "required": [ + "id", + "node_id", + "type" + ] + } + ] + } + }, + "deployment_branch_policy": { + "type": "object", + "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", + "properties": { + "protected_branches": { + "type": "boolean", + "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`." + }, + "custom_branch_policies": { + "type": "boolean", + "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`." + } + }, + "nullable": true, + "required": [ + "protected_branches", + "custom_branch_policies" + ] + } + }, + "required": [ + "id", + "node_id", + "name", + "url", + "html_url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 161088068, + "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", + "name": "staging", + "url": "https://api.github.com/repos/github/hello-world/environments/staging", + "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging", + "created_at": "2020-11-23T22:00:40Z", + "updated_at": "2020-11-23T22:00:40Z", + "protection_rules": [ + { + "id": 3736, + "node_id": "MDQ6R2F0ZTM3MzY=", + "type": "wait_timer", + "wait_timer": 30 + }, + { + "id": 3755, + "node_id": "MDQ6R2F0ZTM3NTU=", + "type": "required_reviewers", + "reviewers": [ + { + "type": "User", + "reviewer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + { + "type": "Team", + "reviewer": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos" + } + } + ] + }, + { + "id": 3756, + "node_id": "MDQ6R2F0ZTM3NTY=", + "type": "branch_policy" + } + ], + "deployment_branch_policy": { + "protected_branches": false, + "custom_branch_policies": true + } + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "environments" + } + }, + "put": { + "summary": "Create or update an environment", + "description": "Create or update an environment with protection rules, such as required reviewers. For more information about environment protection rules, see \"[Environments](/actions/reference/environments#environment-protection-rules).\"\n\n**Note:** Although you can use this operation to specify that only branches that match specified name patterns can deploy to this environment, you must use the UI to set the name patterns. For more information, see \"[Environments](/actions/reference/environments#deployment-branches).\"\n\n**Note:** To create or update secrets for an environment, see \"[Secrets](/rest/reference/actions#secrets).\"\n\nYou must authenticate using an access token with the repo scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/create-or-update-environment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#create-or-update-an-environment" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "nullable": true, + "properties": { + "wait_timer": { + "type": "integer", + "example": 30, + "description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days)." + }, + "reviewers": { + "type": "array", + "nullable": true, + "description": "The people or teams that may review jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of reviewer. Must be one of: `User` or `Team`", + "enum": [ + "User", + "Team" + ], + "example": "User" + }, + "id": { + "type": "integer", + "description": "The id of the user or team who can review the deployment", + "example": 4532992 + } + } + } + }, + "deployment_branch_policy": { + "type": "object", + "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", + "properties": { + "protected_branches": { + "type": "boolean", + "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`." + }, + "custom_branch_policies": { + "type": "boolean", + "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`." + } + }, + "nullable": true, + "required": [ + "protected_branches", + "custom_branch_policies" + ] + } + }, + "additionalProperties": false + } + } + } + }, + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Environment", + "description": "Details of a deployment environment", + "type": "object", + "properties": { + "id": { + "description": "The id of the environment.", + "example": 56780428, + "type": "integer" + }, + "node_id": { + "type": "string", + "example": "MDExOkVudmlyb25tZW50NTY3ODA0Mjg=" + }, + "name": { + "description": "The name of the environment.", + "example": "staging", + "type": "string" + }, + "url": { + "type": "string", + "example": "https://api.github.com/repos/github/hello-world/environments/staging" + }, + "html_url": { + "type": "string", + "example": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging" + }, + "created_at": { + "description": "The time that the environment was created, in ISO 8601 format.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string" + }, + "updated_at": { + "description": "The time that the environment was last updated, in ISO 8601 format.", + "example": "2020-11-23T22:00:40Z", + "format": "date-time", + "type": "string" + }, + "protection_rules": { + "type": "array", + "items": { + "anyOf": [ + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3515 + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM1MTU=" + }, + "type": { + "type": "string", + "example": "wait_timer" + }, + "wait_timer": { + "type": "integer", + "example": 30, + "description": "The amount of time to delay a job after the job is initially triggered. The time (in minutes) must be an integer between 0 and 43,200 (30 days)." + } + }, + "required": [ + "id", + "node_id", + "type" + ] + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3755 + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM3NTU=" + }, + "type": { + "type": "string", + "example": "required_reviewers" + }, + "reviewers": { + "type": "array", + "description": "The people or teams that may approve jobs that reference the environment. You can list up to six users or teams as reviewers. The reviewers must have at least read access to the repository. Only one of the required reviewers needs to approve the job for it to proceed.", + "items": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "The type of reviewer. Must be one of: `User` or `Team`", + "enum": [ + "User", + "Team" + ], + "example": "User" + }, + "reviewer": { + "anyOf": [ + { + "title": "Simple User", + "description": "Simple User", + "type": "object", + "properties": { + "login": { + "type": "string", + "example": "octocat" + }, + "id": { + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VXNlcjE=" + }, + "avatar_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/images/error/octocat_happy.gif" + }, + "gravatar_id": { + "type": "string", + "example": "41d064eb2195891e12d0413f63227ea7", + "nullable": true + }, + "url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/octocat" + }, + "followers_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/followers" + }, + "following_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/following{/other_user}" + }, + "gists_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/gists{/gist_id}" + }, + "starred_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/starred{/owner}{/repo}" + }, + "subscriptions_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/subscriptions" + }, + "organizations_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/orgs" + }, + "repos_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/repos" + }, + "events_url": { + "type": "string", + "example": "https://api.github.com/users/octocat/events{/privacy}" + }, + "received_events_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/users/octocat/received_events" + }, + "type": { + "type": "string", + "example": "User" + }, + "site_admin": { + "type": "boolean" + }, + "starred_at": { + "type": "string", + "example": "\"2020-07-09T00:17:55Z\"" + } + }, + "required": [ + "avatar_url", + "events_url", + "followers_url", + "following_url", + "gists_url", + "gravatar_id", + "html_url", + "id", + "node_id", + "login", + "organizations_url", + "received_events_url", + "repos_url", + "site_admin", + "starred_url", + "subscriptions_url", + "type", + "url" + ], + "nullable": true + }, + { + "title": "Team Simple", + "description": "Groups of organization members that gives permissions on specified repositories.", + "type": "object", + "properties": { + "id": { + "description": "Unique identifier of the team", + "type": "integer", + "example": 1 + }, + "node_id": { + "type": "string", + "example": "MDQ6VGVhbTE=" + }, + "url": { + "description": "URL for the team", + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1" + }, + "members_url": { + "type": "string", + "example": "https://api.github.com/organizations/1/team/1/members{/member}" + }, + "name": { + "description": "Name of the team", + "type": "string", + "example": "Justice League" + }, + "description": { + "description": "Description of the team", + "type": "string", + "nullable": true, + "example": "A great team." + }, + "permission": { + "description": "Permission that the team will have for its repositories", + "type": "string", + "example": "admin" + }, + "privacy": { + "description": "The level of privacy this team should have", + "type": "string", + "example": "closed" + }, + "html_url": { + "type": "string", + "format": "uri", + "example": "https://github.com/orgs/rails/teams/core" + }, + "repositories_url": { + "type": "string", + "format": "uri", + "example": "https://api.github.com/organizations/1/team/1/repos" + }, + "slug": { + "type": "string", + "example": "justice-league" + }, + "ldap_dn": { + "description": "Distinguished Name (DN) that team maps to within LDAP environment", + "example": "uid=example,ou=users,dc=github,dc=com", + "type": "string" + } + }, + "required": [ + "id", + "node_id", + "url", + "members_url", + "name", + "description", + "permission", + "html_url", + "repositories_url", + "slug" + ], + "nullable": true + } + ] + } + } + } + } + }, + "required": [ + "id", + "node_id", + "type" + ] + }, + { + "type": "object", + "properties": { + "id": { + "type": "integer", + "example": 3515 + }, + "node_id": { + "type": "string", + "example": "MDQ6R2F0ZTM1MTU=" + }, + "type": { + "type": "string", + "example": "branch_policy" + } + }, + "required": [ + "id", + "node_id", + "type" + ] + } + ] + } + }, + "deployment_branch_policy": { + "type": "object", + "description": "The type of deployment branch policy for this environment. To allow all branches to deploy, set to `null`.", + "properties": { + "protected_branches": { + "type": "boolean", + "description": "Whether only branches with branch protection rules can deploy to this environment. If `protected_branches` is `true`, `custom_branch_policies` must be `false`; if `protected_branches` is `false`, `custom_branch_policies` must be `true`." + }, + "custom_branch_policies": { + "type": "boolean", + "description": "Whether only branches that match the specified name patterns can deploy to this environment. If `custom_branch_policies` is `true`, `protected_branches` must be `false`; if `custom_branch_policies` is `false`, `protected_branches` must be `true`." + } + }, + "nullable": true, + "required": [ + "protected_branches", + "custom_branch_policies" + ] + } + }, + "required": [ + "id", + "node_id", + "name", + "url", + "html_url", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "id": 161088068, + "node_id": "MDExOkVudmlyb25tZW50MTYxMDg4MDY4", + "name": "staging", + "url": "https://api.github.com/repos/github/hello-world/environments/staging", + "html_url": "https://github.com/github/hello-world/deployments/activity_log?environments_filter=staging", + "created_at": "2020-11-23T22:00:40Z", + "updated_at": "2020-11-23T22:00:40Z", + "protection_rules": [ + { + "id": 3736, + "node_id": "MDQ6R2F0ZTM3MzY=", + "type": "wait_timer", + "wait_timer": 30 + }, + { + "id": 3755, + "node_id": "MDQ6R2F0ZTM3NTU=", + "type": "required_reviewers", + "reviewers": [ + { + "type": "User", + "reviewer": { + "login": "octocat", + "id": 1, + "node_id": "MDQ6VXNlcjE=", + "avatar_url": "https://github.com/images/error/octocat_happy.gif", + "gravatar_id": "", + "url": "https://api.github.com/users/octocat", + "html_url": "https://github.com/octocat", + "followers_url": "https://api.github.com/users/octocat/followers", + "following_url": "https://api.github.com/users/octocat/following{/other_user}", + "gists_url": "https://api.github.com/users/octocat/gists{/gist_id}", + "starred_url": "https://api.github.com/users/octocat/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/octocat/subscriptions", + "organizations_url": "https://api.github.com/users/octocat/orgs", + "repos_url": "https://api.github.com/users/octocat/repos", + "events_url": "https://api.github.com/users/octocat/events{/privacy}", + "received_events_url": "https://api.github.com/users/octocat/received_events", + "type": "User", + "site_admin": false + } + }, + { + "type": "Team", + "reviewer": { + "id": 1, + "node_id": "MDQ6VGVhbTE=", + "url": "https://api.github.com/teams/1", + "html_url": "https://github.com/orgs/github/teams/justice-league", + "name": "Justice League", + "slug": "justice-league", + "description": "A great team.", + "privacy": "closed", + "permission": "admin", + "members_url": "https://api.github.com/teams/1/members{/member}", + "repositories_url": "https://api.github.com/teams/1/repos" + } + } + ] + }, + { + "id": 3756, + "node_id": "MDQ6R2F0ZTM3NTY=", + "type": "branch_policy" + } + ], + "deployment_branch_policy": { + "protected_branches": false, + "custom_branch_policies": true + } + } + } + } + } + } + }, + "422": { + "description": "Validation error when the environment name is invalid or when `protected_branches` and `custom_branch_policies` in `deployment_branch_policy` are set to the same value", + "content": { + "application/json": { + "schema": { + "title": "Basic Error", + "description": "Basic Error", + "type": "object", + "properties": { + "message": { + "type": "string" + }, + "documentation_url": { + "type": "string" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "environments" + } + }, + "delete": { + "summary": "Delete an environment", + "description": "You must authenticate using an access token with the repo scope to use this endpoint.", + "tags": [ + "repos" + ], + "operationId": "repos/delete-an-environment", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/repos#delete-an-environment" + }, + "parameters": [ + { + "name": "owner", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "repo", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "repos", + "subcategory": "environments" + } + } + }, "/repos/{owner}/{repo}/events": { "get": { "summary": "List repository events", @@ -212674,7 +239039,7 @@ "/repos/{template_owner}/{template_repo}/generate": { "post": { "summary": "Create a repository using a template", - "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/github-ae@latest/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository using a repository template. Use the `template_owner` and `template_repo` route parameters to specify the repository to use as the template. The authenticated user must own or be a member of an organization that owns the repository. To check if a repository is available to use as a template, get the repository's information using the [Get a repository](https://docs.github.com/github-ae@latest/rest/reference/repos#get-a-repository) endpoint and check that the `is_template` key is `true`.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository", "tags": [ "repos" ], @@ -213860,7 +240225,7 @@ "/repositories": { "get": { "summary": "List public repositories", - "description": "Lists all public repositories in the order that they were created.\n\nNote: Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", + "description": "Lists all public repositories in the order that they were created.\n\nNotes:\n- For GitHub Enterprise Server and GitHub AE, this endpoint will only list repositories available to all users on the enterprise.\n- Pagination is powered exclusively by the `since` parameter. Use the [Link header](https://docs.github.com/github-ae@latest/rest/overview/resources-in-the-rest-api#link-header) to get the URL for the next page of repositories.", "tags": [ "repos" ], @@ -215545,6 +241910,467 @@ } } }, + "/repositories/{repository_id}/environments/{environment_name}/secrets": { + "get": { + "summary": "List environment secrets", + "description": "Lists all secrets available in an environment without revealing their encrypted values. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/list-environment-secrets", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#list-environment-secrets" + }, + "parameters": [ + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + } + }, + { + "name": "per_page", + "description": "Results per page (max 100).", + "in": "query", + "schema": { + "type": "integer", + "default": 30 + } + }, + { + "name": "page", + "description": "Page number of the results to fetch.", + "in": "query", + "schema": { + "type": "integer", + "default": 1 + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "type": "object", + "required": [ + "total_count", + "secrets" + ], + "properties": { + "total_count": { + "type": "integer" + }, + "secrets": { + "type": "array", + "items": { + "title": "Actions Secret", + "description": "Set secrets for GitHub Actions.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "created_at", + "updated_at" + ] + } + } + } + }, + "examples": { + "default": { + "value": { + "total_count": 2, + "secrets": [ + { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + }, + { + "name": "GIST_ID", + "created_at": "2020-01-10T10:59:22Z", + "updated_at": "2020-01-11T11:59:22Z" + } + ] + } + } + } + } + }, + "headers": { + "Link": { + "example": "; rel=\"next\", ; rel=\"last\"", + "schema": { + "type": "string" + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/repositories/{repository_id}/environments/{environment_name}/secrets/public-key": { + "get": { + "summary": "Get an environment public key", + "description": "Get the public key for an environment, which you need to encrypt environment secrets. You need to encrypt a secret before you can create or update secrets. Anyone with read access to the repository can use this endpoint. If the repository is private you must use an access token with the `repo` scope. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-public-key", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-environment-public-key" + }, + "parameters": [ + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "ActionsPublicKey", + "description": "The public key used for setting Actions Secrets.", + "type": "object", + "properties": { + "key_id": { + "description": "The identifier for the key.", + "type": "string", + "example": "1234567" + }, + "key": { + "description": "The Base64 encoded public key.", + "type": "string", + "example": "hBT5WZEj8ZoOv6TYJsfWq7MxTEQopZO5/IT3ZCVQPzs=" + }, + "id": { + "type": "integer", + "example": 2 + }, + "url": { + "type": "string", + "example": "https://api.github.com/user/keys/2" + }, + "title": { + "type": "string", + "example": "ssh-rsa AAAAB3NzaC1yc2EAAA" + }, + "created_at": { + "type": "string", + "example": "2011-01-26T19:01:12Z" + } + }, + "required": [ + "key_id", + "key" + ] + }, + "examples": { + "default": { + "value": { + "key_id": "012345678912345678", + "key": "2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvv1234" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + } + }, + "/repositories/{repository_id}/environments/{environment_name}/secrets/{secret_name}": { + "get": { + "summary": "Get an environment secret", + "description": "Gets a single environment secret without revealing its encrypted value. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/get-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-environment-secret" + }, + "parameters": [ + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "response", + "content": { + "application/json": { + "schema": { + "title": "Actions Secret", + "description": "Set secrets for GitHub Actions.", + "type": "object", + "properties": { + "name": { + "description": "The name of the secret.", + "example": "SECRET_TOKEN", + "type": "string" + }, + "created_at": { + "type": "string", + "format": "date-time" + }, + "updated_at": { + "type": "string", + "format": "date-time" + } + }, + "required": [ + "name", + "created_at", + "updated_at" + ] + }, + "examples": { + "default": { + "value": { + "name": "GH_TOKEN", + "created_at": "2019-08-10T14:59:22Z", + "updated_at": "2020-01-10T14:59:22Z" + } + } + } + } + } + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + }, + "put": { + "summary": "Create or update an environment secret", + "description": "Creates or updates an environment secret with an encrypted value. Encrypt your secret using\n[LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages). You must authenticate using an access\ntoken with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use\nthis endpoint.\n\n#### Example encrypting a secret using Node.js\n\nEncrypt your secret using the [tweetsodium](https://github.com/github/tweetsodium) library.\n\n```\nconst sodium = require('tweetsodium');\n\nconst key = \"base64-encoded-public-key\";\nconst value = \"plain-text-secret\";\n\n// Convert the message and key to Uint8Array's (Buffer implements that interface)\nconst messageBytes = Buffer.from(value);\nconst keyBytes = Buffer.from(key, 'base64');\n\n// Encrypt using LibSodium.\nconst encryptedBytes = sodium.seal(messageBytes, keyBytes);\n\n// Base64 the encrypted secret\nconst encrypted = Buffer.from(encryptedBytes).toString('base64');\n\nconsole.log(encrypted);\n```\n\n\n#### Example encrypting a secret using Python\n\nEncrypt your secret using [pynacl](https://pynacl.readthedocs.io/en/stable/public/#nacl-public-sealedbox) with Python 3.\n\n```\nfrom base64 import b64encode\nfrom nacl import encoding, public\n\ndef encrypt(public_key: str, secret_value: str) -> str:\n \"\"\"Encrypt a Unicode string using the public key.\"\"\"\n public_key = public.PublicKey(public_key.encode(\"utf-8\"), encoding.Base64Encoder())\n sealed_box = public.SealedBox(public_key)\n encrypted = sealed_box.encrypt(secret_value.encode(\"utf-8\"))\n return b64encode(encrypted).decode(\"utf-8\")\n```\n\n#### Example encrypting a secret using C#\n\nEncrypt your secret using the [Sodium.Core](https://www.nuget.org/packages/Sodium.Core/) package.\n\n```\nvar secretValue = System.Text.Encoding.UTF8.GetBytes(\"mySecret\");\nvar publicKey = Convert.FromBase64String(\"2Sg8iYjAxxmI2LvUXpJjkYrMxURPc8r+dB7TJyvvcCU=\");\n\nvar sealedPublicKeyBox = Sodium.SealedPublicKeyBox.Create(secretValue, publicKey);\n\nConsole.WriteLine(Convert.ToBase64String(sealedPublicKeyBox));\n```\n\n#### Example encrypting a secret using Ruby\n\nEncrypt your secret using the [rbnacl](https://github.com/RubyCrypto/rbnacl) gem.\n\n```ruby\nrequire \"rbnacl\"\nrequire \"base64\"\n\nkey = Base64.decode64(\"+ZYvJDZMHUfBkJdyq5Zm9SKqeuBQ4sj+6sfjlH4CgG0=\")\npublic_key = RbNaCl::PublicKey.new(key)\n\nbox = RbNaCl::Boxes::Sealed.from_public_key(public_key)\nencrypted_secret = box.encrypt(\"my_secret\")\n\n# Print the base64 encoded secret\nputs Base64.strict_encode64(encrypted_secret)\n```", + "tags": [ + "actions" + ], + "operationId": "actions/create-or-update-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#create-or-update-an-environment-secret" + }, + "parameters": [ + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "requestBody": { + "content": { + "application/json": { + "schema": { + "type": "object", + "properties": { + "encrypted_value": { + "type": "string", + "description": "Value for your secret, encrypted with [LibSodium](https://libsodium.gitbook.io/doc/bindings_for_other_languages) using the public key retrieved from the [Get an environment public key](https://docs.github.com/github-ae@latest/rest/reference/actions#get-an-environment-public-key) endpoint.", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + }, + "key_id": { + "type": "string", + "description": "ID of the key you used to encrypt the secret." + } + } + }, + "example": { + "encrypted_value": "c2VjcmV0", + "key_id": "012345678912345678" + } + } + } + }, + "responses": { + "201": { + "description": "Response when creating a secret" + }, + "204": { + "description": "Response when updating a secret" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + }, + "delete": { + "summary": "Delete an environment secret", + "description": "Deletes a secret in an environment using the secret name. You must authenticate using an access token with the `repo` scope to use this endpoint. GitHub Apps must have the `secrets` repository permission to use this endpoint.", + "tags": [ + "actions" + ], + "operationId": "actions/delete-environment-secret", + "externalDocs": { + "description": "API method documentation", + "url": "https://docs.github.com/github-ae@latest/rest/reference/actions#delete-an-environment-secret" + }, + "parameters": [ + { + "name": "repository_id", + "in": "path", + "required": true, + "schema": { + "type": "integer" + } + }, + { + "name": "environment_name", + "in": "path", + "required": true, + "description": "The name of the environment", + "schema": { + "type": "string" + } + }, + { + "name": "secret_name", + "description": "secret_name parameter", + "in": "path", + "required": true, + "schema": { + "type": "string" + } + } + ], + "responses": { + "204": { + "description": "Empty response" + } + }, + "x-github": { + "githubCloudOnly": false, + "enabledForGitHubApps": true, + "previews": [ + + ], + "category": "actions", + "subcategory": "secrets" + } + } + }, "/search/code": { "get": { "summary": "Search code", @@ -246238,7 +273064,7 @@ "parameters": [ { "name": "visibility", - "description": "Can be one of `all`, `public`, or `private`.", + "description": "Can be one of `all`, `public`, or `private`. Note: For GitHub AE, can be one of `all`, `internal`, or `private`.", "in": "query", "required": false, "schema": { @@ -246263,7 +273089,7 @@ }, { "name": "type", - "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", + "description": "Can be one of `all`, `owner`, `public`, `private`, `member`. Note: For GitHub AE, can be one of `all`, `owner`, `internal`, `private`, `member`. Default: `all` \n \nWill cause a `422` error if used in the same request as **visibility** or **affiliation**. Will cause a `422` error if used in the same request as **visibility** or **affiliation**.", "in": "query", "required": false, "schema": { @@ -247571,7 +274397,7 @@ }, "post": { "summary": "Create a repository for the authenticated user", - "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository\n* `repo` scope to create a private repository", + "description": "Creates a new repository for the authenticated user.\n\n**OAuth scope requirements**\n\nWhen using [OAuth](https://docs.github.com/github-ae@latest/apps/building-oauth-apps/understanding-scopes-for-oauth-apps/), authorizations must include:\n\n* `public_repo` scope or `repo` scope to create a public repository. Note: For GitHub AE, use `repo` scope to create an internal repository.\n* `repo` scope to create a private repository.", "tags": [ "repos" ], @@ -247602,7 +274428,7 @@ "type": "string" }, "private": { - "description": "Whether the repository is private or public.", + "description": "Whether the repository is private.", "default": false, "type": "boolean" }, @@ -273447,7 +300273,7 @@ "/users/{username}/repos": { "get": { "summary": "List repositories for a user", - "description": "Lists public repositories for the specified user.", + "description": "Lists public repositories for the specified user. Note: For GitHub AE, this endpoint will list internal repositories for the specified user.", "tags": [ "repos" ], diff --git a/lib/warm-server.js b/lib/warm-server.js index 687de15dcca2..0b6622914f3e 100644 --- a/lib/warm-server.js +++ b/lib/warm-server.js @@ -9,7 +9,7 @@ const loadSiteTree = require('./site-tree') const dog = { loadPages: statsd.asyncTimer(loadPages, 'load_pages'), loadPageMap: statsd.asyncTimer(loadPageMap, 'load_page_map'), - loadRedirects: statsd.timer(loadRedirects, 'load_redirects'), + loadRedirects: statsd.asyncTimer(loadRedirects, 'load_redirects'), loadSiteData: statsd.timer(loadSiteData, 'load_site_data'), loadSiteTree: statsd.asyncTimer(loadSiteTree, 'load_site_tree') } @@ -52,7 +52,7 @@ async function warmServer () { } if (!redirects) { - redirects = dog.loadRedirects(pageList, pageMap) + redirects = await dog.loadRedirects(pageList, pageMap) } if (!siteTree) { diff --git a/lib/webhooks/static/dotcom/code_scanning_alert.reopened.payload.json b/lib/webhooks/static/dotcom/code_scanning_alert.reopened.payload.json index f1de7c2a2854..6f56c67b0487 100644 --- a/lib/webhooks/static/dotcom/code_scanning_alert.reopened.payload.json +++ b/lib/webhooks/static/dotcom/code_scanning_alert.reopened.payload.json @@ -141,31 +141,20 @@ "login": "github", "id": 9919, "node_id": "MDEyOk9yZ2FuaXphdGlvbjk5MTk=", - "url": "https://api.github.com/orgs/github", - "repos_url": "https://api.github.com/orgs/github/repos", - "events_url": "https://api.github.com/orgs/github/events", - "hooks_url": "https://api.github.com/orgs/github/hooks", - "issues_url": "https://api.github.com/orgs/github/issues", - "members_url": "https://api.github.com/orgs/github/members{/member}", - "public_members_url": "https://api.github.com/orgs/github/public_members{/member}", "avatar_url": "https://avatars.githubusercontent.com/u/9919?v=4", - "description": "How people build software.", - "name": "GitHub", - "company": null, - "blog": "https://github.com/about", - "location": "San Francisco, CA", - "email": null, - "twitter_username": null, - "is_verified": true, - "has_organization_projects": true, - "has_repository_projects": true, - "public_repos": 371, - "public_gists": 0, - "followers": 0, - "following": 0, + "gravatar_id": "", + "url": "https://api.github.com/users/github", "html_url": "https://github.com/github", - "created_at": "2008-05-11T04:37:31Z", - "updated_at": "2020-09-28T06:15:10Z", - "type": "Organization" + "followers_url": "https://api.github.com/users/github/followers", + "following_url": "https://api.github.com/users/github/following{/other_user}", + "gists_url": "https://api.github.com/users/github/gists{/gist_id}", + "starred_url": "https://api.github.com/users/github/starred{/owner}{/repo}", + "subscriptions_url": "https://api.github.com/users/github/subscriptions", + "organizations_url": "https://api.github.com/users/github/orgs", + "repos_url": "https://api.github.com/users/github/repos", + "events_url": "https://api.github.com/users/github/events{/privacy}", + "received_events_url": "https://api.github.com/users/github/received_events", + "type": "Organization", + "site_admin": false } } diff --git a/lib/webhooks/static/ghae/check_run.completed.payload.json b/lib/webhooks/static/ghae/check_run.completed.payload.json index cbab42def24b..ed6b34b6721f 100644 --- a/lib/webhooks/static/ghae/check_run.completed.payload.json +++ b/lib/webhooks/static/ghae/check_run.completed.payload.json @@ -250,7 +250,20 @@ } } } - ] + ], + "deployment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728", + "id": 326191728, + "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=", + "task": "deploy", + "original_environment": "lab", + "environment": "lab", + "description": null, + "created_at": "2021-02-18T08:22:48Z", + "updated_at": "2021-02-18T09:47:16Z", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses", + "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" + } }, "repository": { "id": 118, diff --git a/lib/webhooks/static/ghae/check_run.created.payload.json b/lib/webhooks/static/ghae/check_run.created.payload.json index a85f42c20701..f6d24e30d987 100644 --- a/lib/webhooks/static/ghae/check_run.created.payload.json +++ b/lib/webhooks/static/ghae/check_run.created.payload.json @@ -250,7 +250,20 @@ } } } - ] + ], + "deployment": { + "url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728", + "id": 326191728, + "node_id": "MDEwOkRlcGxveW1lbnQzMjYxOTE3Mjg=", + "task": "deploy", + "original_environment": "lab", + "environment": "lab", + "description": null, + "created_at": "2021-02-18T08:22:48Z", + "updated_at": "2021-02-18T09:47:16Z", + "statuses_url": "https://api.github.com/repos/Codertocat/Hello-World/deployments/326191728/statuses", + "repository_url": "https://api.github.com/repos/Codertocat/Hello-World" + } }, "repository": { "id": 118, diff --git a/middleware/archived-enterprise-versions.js b/middleware/archived-enterprise-versions.js index 682793d9757b..422484f977e0 100644 --- a/middleware/archived-enterprise-versions.js +++ b/middleware/archived-enterprise-versions.js @@ -1,6 +1,6 @@ const path = require('path') const slash = require('slash') -const { firstVersionDeprecatedOnNewSite, lastVersionWithoutStubbedRedirectFiles } = require('../lib/enterprise-server-releases') +const { firstVersionDeprecatedOnNewSite, lastVersionWithoutArchivedRedirectsFile } = require('../lib/enterprise-server-releases') const patterns = require('../lib/patterns') const versionSatisfiesRange = require('../lib/version-satisfies-range') const isArchivedVersion = require('../lib/is-archived-version') @@ -25,21 +25,43 @@ module.exports = async (req, res, next) => { } // find redirects for versions between 2.13 and 2.17 - // starting with 2.18, we updated the archival script to create stubbed HTML redirect files + // starting with 2.18, we updated the archival script to create a redirects.json file if (versionSatisfiesRange(requestedVersion, `>=${firstVersionDeprecatedOnNewSite}`) && - versionSatisfiesRange(requestedVersion, `<=${lastVersionWithoutStubbedRedirectFiles}`)) { + versionSatisfiesRange(requestedVersion, `<=${lastVersionWithoutArchivedRedirectsFile}`)) { const redirect = archvivedRedirects[req.path] if (redirect && redirect !== req.path) { return res.redirect(301, redirect) } } + let reqPath = req.path + let isRedirect = false + if (versionSatisfiesRange(requestedVersion, `>${lastVersionWithoutArchivedRedirectsFile}`)) { + try { + const res = await got(getProxyPath('redirects.json', requestedVersion)) + const redirectJson = JSON.parse(res.body) + + if (redirectJson[req.path]) { + isRedirect = true + } + reqPath = redirectJson[req.path] || req.path + } catch (err) { + // nooop + } + } + try { - const r = await got(getProxyPath(req.path, requestedVersion)) + const r = await got(getProxyPath(reqPath, requestedVersion)) res.set('content-type', r.headers['content-type']) res.set('x-robots-tag', 'noindex') - // make the stubbed redirect files added in >=2.18 return 301 instead of 200 + // make redirects found via redirects.json return 301 instead of 200 + if (isRedirect) { + res.status(301) + res.set('location', reqPath) + } + + // make stubbed redirect files (which exist in versions <2.13) return 301 instead of 200 const staticRedirect = r.body.match(patterns.staticRedirect) if (staticRedirect) { res.status(301) @@ -73,7 +95,7 @@ function getProxyPath (reqPath, requestedVersion) { // this workaround finds potentially relevant frontmatter redirects in currently supported pages function getFallbackRedirects (req, requestedVersion) { if (versionSatisfiesRange(requestedVersion, `<${firstVersionDeprecatedOnNewSite}`)) return - if (versionSatisfiesRange(requestedVersion, `>${lastVersionWithoutStubbedRedirectFiles}`)) return + if (versionSatisfiesRange(requestedVersion, `>${lastVersionWithoutArchivedRedirectsFile}`)) return return archivedFrontmatterFallbacks.find(arrayOfFallbacks => arrayOfFallbacks.includes(req.path)) } diff --git a/middleware/rate-limit.js b/middleware/rate-limit.js index a648b39e797c..77960ae3d425 100644 --- a/middleware/rate-limit.js +++ b/middleware/rate-limit.js @@ -19,9 +19,14 @@ module.exports = rateLimit({ store: REDIS_URL && new RedisStore({ client: new Redis(REDIS_URL, { db: rateLimitDatabaseNumber, - tls: { - // Required for production Heroku Redis - rejectUnauthorized: false + + // Only add this configuration for TLS-enabled REDIS_URL values. + // Otherwise, it breaks for local Redis instances without TLS enabled. + ...REDIS_URL.startsWith('rediss://') && { + tls: { + // Required for production Heroku Redis + rejectUnauthorized: false + } } }), // 1 minute (or practically unlimited outside of production) diff --git a/script/enterprise-server-deprecations/archive-version.js b/script/enterprise-server-deprecations/archive-version.js index 2cbc93904932..8493a9dc609a 100755 --- a/script/enterprise-server-deprecations/archive-version.js +++ b/script/enterprise-server-deprecations/archive-version.js @@ -9,7 +9,6 @@ const host = `http://localhost:${port}` const scrape = require('website-scraper') const program = require('commander') const rimraf = require('rimraf').sync -const mkdirp = require('mkdirp').sync const version = require('../../lib/enterprise-server-releases').oldestSupported const archivalRepoName = 'help-docs-archived-enterprise-versions' const archivalRepoUrl = `https://github.com/github/${archivalRepoName}` @@ -173,7 +172,7 @@ async function main () { console.log(`\n\ndone scraping! added files to ${path.relative(process.cwd(), finalDirectory)}\n`) // create redirect html files to preserve frontmatter redirects - await createRedirectPages(permalinksPerVersion, pageMap, finalDirectory) + await createRedirectsFile(permalinksPerVersion, pageMap, finalDirectory) console.log(`next step: deprecate ${version} in lib/enterprise-server-releases.js`) @@ -181,10 +180,12 @@ async function main () { }) } -async function createRedirectPages (permalinks, pageMap, finalDirectory) { +async function createRedirectsFile (permalinks, pageMap, finalDirectory) { const pagesPerVersion = permalinks.map(permalink => pageMap[permalink]) const redirects = await loadRedirects(pagesPerVersion, pageMap) + const redirectsPerVersion = {} + Object.entries(redirects).forEach(([oldPath, newPath]) => { // remove any liquid variables that sneak in oldPath = oldPath @@ -193,31 +194,8 @@ async function createRedirectPages (permalinks, pageMap, finalDirectory) { // ignore any old paths that are not in this version if (!(oldPath.includes(`/enterprise-server@${version}`) || oldPath.includes(`/enterprise/${version}`))) return - const fullPath = path.join(finalDirectory, oldPath) - const filename = `${fullPath}/index.html` - const html = getRedirectHtml(newPath) - - mkdirp(fullPath) - fs.writeFileSync(filename, html) + redirectsPerVersion[oldPath] = newPath }) - console.log('done creating redirect files!\n') -} - -// redirect html files already exist in <=2.12 because these versions were deprecated on the old static site -function getRedirectHtml (newPath) { - return ` - - - -Redirecting... - - - - -

Redirecting...

-Click here if you are not redirected. - - -` + fs.writeFileSync(path.posix.join(finalDirectory, 'redirects.json'), JSON.stringify(redirectsPerVersion, null, 2)) } diff --git a/script/enterprise-server-releases/ghes-to-ghae-versioning.js b/script/enterprise-server-releases/ghes-to-ghae-versioning.js index 0813f03962b8..c497890d9db7 100755 --- a/script/enterprise-server-releases/ghes-to-ghae-versioning.js +++ b/script/enterprise-server-releases/ghes-to-ghae-versioning.js @@ -14,7 +14,7 @@ const versionSatisfiesRange = require('../../lib/version-satisfies-range') // [start-readme] // // Run this script to add versions frontmatter and Liquid conditionals for -// GitHub AE, based on anything currently versioned for the provided release +// GitHub AE, based on anything currently versioned for the specified release // of Enterprise Server. This script should be run as part of the Enterprise // Server release process. // @@ -23,28 +23,23 @@ const versionSatisfiesRange = require('../../lib/version-satisfies-range') program .description('Add versions frontmatter and Liquid conditionals for GitHub AE based on a given Enterprise Server release. Runs on all content by default.') .option('-r, --ghes-release ', 'The Enterprise Server release to base AE versioning on. Example: 2.23') - .option('-p, --products [PRODUCT_IDS...]', 'List of space-separated product IDs. Example: admin github developers') - .option('-c, --currentServerReleases', 'Also add AE versioning to conditionals for current Enterprise Server releases.') - .option('-t, --translations', 'Run the script on content and data in translations, too.') + .option('-p, --products [OPTIONAL PRODUCT_IDS...]', 'Optional list of space-separated product IDs. Example: admin github developers') + .option('-t, --translations', 'Run the script on content and data in translations too.') .parse(process.argv) if (!program.ghesRelease) { - console.log('Must provide an Enterprise Server release number!') - process.exit() + console.error('Must provide an Enterprise Server release number!') + process.exit(1) } +console.log(`✅ Adding AE versioning based on GHES ${program.ghesRelease} versioning`) + if (program.products) { console.log(`✅ Running on the following products: ${program.products}`) } else { console.log('✅ Running on all products') } -if (program.currentServerReleases) { - console.log(`✅ Adding AE versioning based on GHES ${program.ghesRelease} versioning and all currently supported GHES versions`) -} else { - console.log(`✅ Adding AE versioning based only on GHES ${program.ghesRelease} versioning`) -} - if (program.translations) { console.log('✅ Running on both English and translated content and data\n') } else { @@ -54,17 +49,14 @@ if (program.translations) { // The new conditional to add const githubAEConditional = 'currentVersion == "github-ae@latest"' -// Existing conditionals to hook on (if program.currentServerReleases is true) -const notDotcomConditional = /currentVersion != "free-pro-team@latest" (or)?(?!and)/ -const allGHESVersionsConditional = /enterpriseServerVersions contains currentVersion (or)?/ - // Match: currentVersion "enterprise-server@(\d+\.\d+)" -const getEnterpriseServerConditional = new RegExp(`currentVersion (\\S+?) "${getEnterpriseServerNumber.source}"`) +// Example: currentVersion ver_gt "enterprise-server@2.21" +const enterpriseServerConditionalRegex = new RegExp(`currentVersion (\\S+?) "${getEnterpriseServerNumber.source}"`) console.log('Working...\n') const englishContentFiles = walkContent(contentPath) -const englishDataFiles = walkData(dataPath, englishContentFiles) +const englishDataFiles = walkData(dataPath) function walkContent (dirPath) { const products = program.products || [''] @@ -77,7 +69,7 @@ function walkContent (dirPath) { }).flat() } -function walkData (dirPath, contentFiles) { +function walkData (dirPath) { return walk(dirPath, { includeBasePath: true, directories: false }) .filter(file => file.includes('/data/reusables') || file.includes('/data/variables')) .filter(file => !file.endsWith('README.md')) @@ -86,7 +78,7 @@ function walkData (dirPath, contentFiles) { let allContentFiles, allDataFiles if (program.translations) { const translatedContentFiles = walkContent(translationsPath) - const translatedDataFiles = walkData(translationsPath, translatedContentFiles) + const translatedDataFiles = walkData(translationsPath) allContentFiles = englishContentFiles.concat(translatedContentFiles) allDataFiles = englishDataFiles.concat(translatedDataFiles) } else { @@ -101,16 +93,21 @@ const operators = { '==': '=' } +// Update the data files allDataFiles .forEach(file => { const dataContent = fs.readFileSync(file, 'utf8') + const conditionalsToUpdate = getConditionalsToUpdate(dataContent) + if (!conditionalsToUpdate.length) return + // Update Liquid in data files - const newDataContent = updateLiquid(dataContent, file) + const newDataContent = updateLiquid(conditionalsToUpdate, dataContent) fs.writeFileSync(file, newDataContent) }) +// Update the content files allContentFiles .forEach(file => { const { data, content } = frontmatter(fs.readFileSync(file, 'utf8')) @@ -118,63 +115,42 @@ allContentFiles // Return early if the current page frontmatter does not apply to either GHAE or the given GHES release if (!(data.versions['github-ae'] || versionSatisfiesRange(program.ghesRelease, data.versions['enterprise-server']))) return - // Add frontmatter version - data.versions['github-ae'] = '*' + const conditionalsToUpdate = getConditionalsToUpdate(content) + if (!conditionalsToUpdate.length) return // Update Liquid in content files - const newContent = updateLiquid(content, file) + const newContent = updateLiquid(conditionalsToUpdate, content) + + // Add frontmatter version + data.versions['github-ae'] = '*' // Update Liquid in frontmatter props Object.keys(data) .filter(key => typeof data[key] === 'string') .forEach(key => { - data[key] = updateLiquid(data[key], file) + const conditionalsToUpdate = getConditionalsToUpdate(data[key]) + if (!conditionalsToUpdate.length) return + data[key] = updateLiquid(conditionalsToUpdate, data[key]) }) fs.writeFileSync(file, frontmatter.stringify(newContent, data, { lineWidth: 10000 })) }) -function updateLiquid (content, file) { - // We need to match on all conditionals first because we have to do replacements _within_ conditionals +function getConditionalsToUpdate (content) { const allConditionals = content.match(/{% if .+?%}/g) - if (!allConditionals) return content - let newContent = content + return (allConditionals || []) + .filter(conditional => !conditional.includes('github-ae')) + .filter(conditional => doesReleaseSatisfyConditional(conditional.match(enterpriseServerConditionalRegex))) +} - allConditionals.forEach(conditional => { - // Do not process a conditional that already includes github-ae - if (conditional.includes('github-ae')) return +function updateLiquid (conditionalsToUpdate, content) { + let newContent = content + conditionalsToUpdate.forEach(conditional => { let newConditional = conditional - // Example match: currentVersion ver_gt "enterprise-server@2.21" - const enterpriseServerMatch = newConditional.match(getEnterpriseServerConditional) - - // Add AE conditional to any `currentVersion != "free-pro-team@latest"` - if (program.currentServerReleases && newConditional.match(notDotcomConditional)) { - if (enterpriseServerMatch && !doesReleaseSatisfyConditional(enterpriseServerMatch)) return - - newConditional = newConditional.replace(/( ?)%}/, `$1or ${githubAEConditional} %}`) - newContent = newContent.replace(conditional, newConditional) - return - } - - // Add AE conditional to any `enterpriseServerVersions contains currentVersion` - if (program.currentServerReleases && newConditional.match(allGHESVersionsConditional)) { - if (enterpriseServerMatch && !doesReleaseSatisfyConditional(enterpriseServerMatch)) return - - newConditional = newConditional.replace(/( ?)%}/, `$1or ${githubAEConditional} %}`) - newContent = newContent.replace(conditional, newConditional) - return - } - - // Add AE conditional to any conditional that applies to enterprise-server@ - if (!enterpriseServerMatch) return - - const releaseSatisfiesConditional = doesReleaseSatisfyConditional(enterpriseServerMatch) - - // Return early if the conditional does not apply to the given GHES release - if (!releaseSatisfiesConditional) return + const enterpriseServerMatch = conditional.match(enterpriseServerConditionalRegex) // First do the replacement within the conditional // Old: {% if currentVersion == "free-pro-team@latest" or currentVersion ver_gt "enterprise-server@2.21" %} @@ -191,6 +167,8 @@ function updateLiquid (content, file) { console.log('Done!') function doesReleaseSatisfyConditional (enterpriseServerMatch) { + if (!enterpriseServerMatch) return + // Example liquid operator: ver_gt const liquidOperator = enterpriseServerMatch[1] diff --git a/script/purge-redis-pages.js b/script/purge-redis-pages.js index fe57960ed598..13f9ad98c364 100644 --- a/script/purge-redis-pages.js +++ b/script/purge-redis-pages.js @@ -44,9 +44,14 @@ purgeRenderedPageCache() function purgeRenderedPageCache () { const redisClient = new Redis(REDIS_URL, { db: pageCacheDatabaseNumber, - tls: { - // Required for production Heroku Redis - rejectUnauthorized: false + + // Only add this configuration for TLS-enabled REDIS_URL values. + // Otherwise, it breaks for local Redis instances without TLS enabled. + ...REDIS_URL.startsWith('rediss://') && { + tls: { + // Required for production Heroku Redis + rejectUnauthorized: false + } } }) let totalKeyCount = 0 diff --git a/script/rest/update-files.js b/script/rest/update-files.js index c52ec9961011..8b42275334f2 100755 --- a/script/rest/update-files.js +++ b/script/rest/update-files.js @@ -59,7 +59,7 @@ async function getDereferencedFiles () { console.log(`\n🏃‍♀️🏃🏃‍♀️Running \`bin/openapi bundle\` in branch '${githubBranch}' of your github/github checkout to generate the dereferenced OpenAPI schema files.\n`) try { - execSync(`${path.join(githubRepoDir, 'bin/openapi')} bundle ${tempDocsDir}`, { stdio: 'inherit' }) + execSync(`${path.join(githubRepoDir, 'bin/openapi')} bundle -o ${tempDocsDir}`, { stdio: 'inherit' }) } catch (error) { console.error(error) console.log('🛑 Whoops! It looks like the `bin/openapi bundle` command failed to run in your `github/github` repository checkout. To troubleshoot, ensure that your OpenAPI schema YAML is formatted correctly. A CI test runs on your `github/github` PR that flags malformed YAML. You can check the PR diff view for comments left by the openapi CI test to find and fix any formatting errors.') diff --git a/script/update-internal-links.js b/script/update-internal-links.js new file mode 100755 index 000000000000..2089937becf1 --- /dev/null +++ b/script/update-internal-links.js @@ -0,0 +1,197 @@ +#!/usr/bin/env node + +const fs = require('fs') +const walk = require('walk-sync') +const path = require('path') +const astFromMarkdown = require('mdast-util-from-markdown') +const visit = require('unist-util-visit') +const { loadPages, loadPageMap } = require('../lib/pages') +const loadSiteData = require('../lib/site-data') +const loadRedirects = require('../lib/redirects/precompile') +const { getPathWithoutLanguage, getPathWithoutVersion } = require('../lib/path-utils') +const allVersions = Object.keys(require('../lib/all-versions')) +const frontmatter = require('../lib/read-frontmatter') +const renderContent = require('../lib/render-content') +const patterns = require('../lib/patterns') + +const walkFiles = (pathToWalk) => { + return walk(path.posix.join(__dirname, '..', pathToWalk), { includeBasePath: true, directories: false }) + .filter(file => file.endsWith('.md') && !file.endsWith('README.md')) + .filter(file => !file.includes('/early-access/')) // ignore EA for now +} + +const allFiles = walkFiles('content').concat(walkFiles('data')) + +// The script will throw an error if it finds any markup not represented here. +// Hacky but it captures the current rare edge cases. +const linkInlineMarkup = { + emphasis: '*', + strong: '**' +} + +const currentVersionWithSpacesRegex = /\/enterprise\/{{ currentVersion }}/g +const currentVersionWithoutSpaces = '/enterprise/{{currentVersion}}' + +// [start-readme] +// +// Run this script to find internal links in all content and data Markdown files, check if either the title or link +// (or both) are outdated, and automatically update them if so. +// +// Exceptions: +// * Links with fragments (e.g., [Bar](/foo#bar)) will get their root links updated if necessary, but the fragment +// and title will be unchanged (e.g., [Bar](/noo#bar)). +// * Links with hardcoded versions (e.g., [Foo](/enterprise-server/baz)) will get their root links updated if +// necessary, but the hardcoded versions will be preserved (e.g., [Foo](/enterprise-server/qux)). +// * Links with Liquid in the titles will have their root links updated if necessary, but the titles will be preserved. +// +// [end-readme] + +main() + +async function main () { + console.log('Working...') + const pageList = await loadPages() + const pageMap = await loadPageMap(pageList) + const redirects = await loadRedirects(pageList) + const site = await loadSiteData() + + const context = { + pages: pageMap, + redirects, + site: site.en.site, + currentLanguage: 'en' + } + + for (const file of allFiles) { + const { data, content } = frontmatter(fs.readFileSync(file, 'utf8')) + let newContent = content + + // Do a blanket find-replace for /enterprise/{{ currentVersion }}/ to /enterprise/{{currentVersion}}/ + // so that the AST parser recognizes the link as a link node. The spaces prevent it from doing so. + newContent = newContent.replace(currentVersionWithSpacesRegex, currentVersionWithoutSpaces) + + const ast = astFromMarkdown(newContent) + + // We can't do async functions within visit, so gather the nodes upfront + const nodesPerFile = [] + + visit(ast, node => { + if (node.type !== 'link') return + if (!node.url.startsWith('/')) return + if (node.url.startsWith('/assets')) return + if (node.url.startsWith('/public')) return + if (node.url.includes('/11.10.340/')) return + if (node.url.includes('/2.1/')) return + if (node.url === '/') return + + nodesPerFile.push(node) + }) + + // For every Markdown link... + for (const node of nodesPerFile) { + const oldLink = node.url + + // Find and preserve any inline markup in link titles, like [*Foo*](/foo) + let inlineMarkup = '' + if (node.children[0].children) { + inlineMarkup = linkInlineMarkup[node.children[0].type] + + if (!inlineMarkup) { + console.error(`Cannot find an inline markup entry for ${node.children[0].type}!`) + process.exit(1) + } + } + + const oldTitle = node.children[0].value || node.children[0].children[0].value + const oldMarkdownLink = `[${inlineMarkup}${oldTitle}${inlineMarkup}](${oldLink})` + + // As a blanket rule, only update titles in links that begin with quotes. (Many links + // have punctuation before the closing quotes, so we'll only check for opening quotes.) + // Update: "[Foo](/foo) + // Do not update: [Bar](/bar) + const hasQuotesAroundLink = newContent.includes(`"${oldMarkdownLink}`) + + let foundPage, fragmentMatch, versionMatch + + // Run through all supported versions... + for (const version of allVersions) { + context.currentVersion = version + // Render the link for each version using the renderContent pipeline, which includes the rewrite-local-links plugin. + const $ = await renderContent(oldMarkdownLink, context, { cheerioObject: true }) + let linkToCheck = $('a').attr('href') + + // We need to preserve fragments and hardcoded versions if any are found. + fragmentMatch = oldLink.match(/(#.*$)/) + versionMatch = oldLink.match(/(enterprise-server(?:@.[^/]*?)?)\//) + + // Remove the fragment for now. + linkToCheck = linkToCheck + .replace(/#.*$/, '') + .replace(patterns.trailingSlash, '$1') + + // Try to find the rendered link in the set of pages! + foundPage = findPage(linkToCheck, pageMap, redirects) + + // Once a page is found for a particular version, exit immediately; we don't need to check the other versions + // because all we care about is the page title and path. + if (foundPage) { + break + } + } + + if (!foundPage) { + console.error(`Can't find link in pageMap! ${oldLink} in ${file.replace(process.cwd(), '')}`) + process.exit(1) + } + + // If the original link includes a fragment OR the original title includes Liquid, do not change; + // otherwise, use the found page title. (We don't want to update the title if a fragment is found because + // the title likely points to the fragment section header, not the page title.) + const newTitle = fragmentMatch || oldTitle.includes('{%') || !hasQuotesAroundLink ? oldTitle : foundPage.title + + // If the original link includes a fragment, append it to the found page path. + // Also remove the language code because Markdown links don't include language codes. + let newLink = getPathWithoutLanguage(fragmentMatch ? foundPage.path + fragmentMatch[1] : foundPage.path) + + // If the original link includes a hardcoded version, preserve it; otherwise, remove versioning + // because Markdown links don't include versioning. + newLink = versionMatch ? `/${versionMatch[1]}${getPathWithoutVersion(newLink)}` : getPathWithoutVersion(newLink) + + let newMarkdownLink = `[${inlineMarkup}${newTitle}${inlineMarkup}](${newLink})` + + // Handle a few misplaced quotation marks. + if (oldMarkdownLink.includes('["')) { + newMarkdownLink = `"${newMarkdownLink}` + } + + // Stream the results to console as we find them. + if (oldMarkdownLink !== newMarkdownLink) { + console.log('old link', oldMarkdownLink) + console.log('new link', newMarkdownLink) + console.log('-------') + } + + newContent = newContent.replace(oldMarkdownLink, newMarkdownLink) + } + + fs.writeFileSync(file, frontmatter.stringify(newContent, data, { lineWidth: 10000 })) + } + + console.log('Done!') +} + +function findPage (tryPath, pageMap, redirects) { + if (pageMap[tryPath]) { + return { + title: pageMap[tryPath].title, + path: tryPath + } + } + + if (pageMap[redirects[tryPath]]) { + return { + title: pageMap[redirects[tryPath]].title, + path: redirects[tryPath] + } + } +} diff --git a/stylesheets/overrides.scss b/stylesheets/overrides.scss index ec003fd7212e..056b5eeff023 100644 --- a/stylesheets/overrides.scss +++ b/stylesheets/overrides.scss @@ -172,3 +172,12 @@ pre .bluebox { fill: $white; } } + +.markdown-body li img { + max-width: calc(100% - 32px); +} + +.markdown-body img { + max-height: 600px; +} + diff --git a/tests/meta/repository-references.js b/tests/meta/repository-references.js index e9ffef4a8422..a33c93e3d29f 100644 --- a/tests/meta/repository-references.js +++ b/tests/meta/repository-references.js @@ -31,10 +31,16 @@ const ALLOW_LIST = new Set([ 'rest-api-description', 'smimesign', 'tweetsodium', - 'choosealicense.com' + 'choosealicense.com', + 'renaming' ]) describe('check for repository references', () => { + // This tests exists to make sure we don't reference private GitHub owned repositories + // in our open-soure repository. If this is failing, and the repo is public, + // feel free to add it to the list above. Or if the feature requires referencing an + // internal repo, add the feature to the ignore list below. + const filenames = walkSync(process.cwd(), { directories: false, ignore: [ diff --git a/tests/routing/deprecated-enterprise-versions.js b/tests/routing/deprecated-enterprise-versions.js index 8969b732b4e2..6ef55122e0b3 100644 --- a/tests/routing/deprecated-enterprise-versions.js +++ b/tests/routing/deprecated-enterprise-versions.js @@ -30,6 +30,12 @@ describe('enterprise deprecation', () => { expect(res.headers.location).toBe('/en/enterprise/2.15/user/articles/viewing-contributions-on-your-profile') }) + test('can access redirects from redirects.json in deprecated enterprise content >2.17', async () => { + const res = await get('/enterprise/2.19/admin/categories/time') + expect(res.statusCode).toBe(301) + expect(res.headers.location).toBe('/en/enterprise-server@2.19/admin/configuration/configuring-time-synchronization') + }) + test('handles requests for deprecated Enterprise pages ( >=2.13 )', async () => { expect(enterpriseServerReleases.deprecated.includes('2.13')).toBe(true) const $ = await getDOM('/en/enterprise/2.13/user/articles/about-branches') diff --git a/tests/routing/redirects.js b/tests/routing/redirects.js index 90178cc6630c..e3614da78776 100644 --- a/tests/routing/redirects.js +++ b/tests/routing/redirects.js @@ -159,6 +159,12 @@ describe('redirects', () => { expect(res.statusCode).toBe(301) expect(res.headers.location).toBe(japaneseEnterpriseHome) }) + + test('hardcoded @latest redirects to latest version', async () => { + const res = await get('/en/enterprise-server@latest') + expect(res.statusCode).toBe(301) + expect(res.headers.location).toBe(enterpriseHome) + }) }) describe('2.13+ deprecated enterprise', () => { diff --git a/translations/de-DE/content/actions/hosting-your-own-runners/about-self-hosted-runners.md b/translations/de-DE/content/actions/hosting-your-own-runners/about-self-hosted-runners.md index 70bf5b1467ec..741d6fc4b422 100644 --- a/translations/de-DE/content/actions/hosting-your-own-runners/about-self-hosted-runners.md +++ b/translations/de-DE/content/actions/hosting-your-own-runners/about-self-hosted-runners.md @@ -120,6 +120,7 @@ Du musst sicherstellen, dass der Rechner über den entsprechenden Netzwerkzugrif github.com api.github.com *.actions.githubusercontent.com +github-releases.githubusercontent.com codeload.github.com ``` diff --git a/translations/es-ES/content/actions/hosting-your-own-runners/about-self-hosted-runners.md b/translations/es-ES/content/actions/hosting-your-own-runners/about-self-hosted-runners.md index 271838494f9d..1ba4e1b0d605 100644 --- a/translations/es-ES/content/actions/hosting-your-own-runners/about-self-hosted-runners.md +++ b/translations/es-ES/content/actions/hosting-your-own-runners/about-self-hosted-runners.md @@ -120,6 +120,7 @@ You must ensure that the machine has the appropriate network access to communica github.com api.github.com *.actions.githubusercontent.com +github-releases.githubusercontent.com codeload.github.com ``` 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 41884cf3cc70..7a09e8f5a893 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 @@ -120,6 +120,7 @@ The self-hosted runner polls {% data variables.product.prodname_dotcom %} to ret github.com api.github.com *.actions.githubusercontent.com +github-releases.githubusercontent.com codeload.github.com ``` diff --git a/translations/ko-KR/content/actions/hosting-your-own-runners/about-self-hosted-runners.md b/translations/ko-KR/content/actions/hosting-your-own-runners/about-self-hosted-runners.md index 251556fb90a2..cd0589961425 100644 --- a/translations/ko-KR/content/actions/hosting-your-own-runners/about-self-hosted-runners.md +++ b/translations/ko-KR/content/actions/hosting-your-own-runners/about-self-hosted-runners.md @@ -120,6 +120,7 @@ You must ensure that the machine has the appropriate network access to communica github.com api.github.com *.actions.githubusercontent.com +github-releases.githubusercontent.com codeload.github.com ``` 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 f2ac28d03807..b7946dfbf332 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 @@ -120,6 +120,7 @@ Você deve garantir que a máquina tenha acesso adequado à rede para comunicar- github.com api.github.com *.actions.githubusercontent.com +github-releases.githubusercontent.com codeload.github.com ``` diff --git a/translations/ru-RU/content/actions/hosting-your-own-runners/about-self-hosted-runners.md b/translations/ru-RU/content/actions/hosting-your-own-runners/about-self-hosted-runners.md index 251556fb90a2..cd0589961425 100644 --- a/translations/ru-RU/content/actions/hosting-your-own-runners/about-self-hosted-runners.md +++ b/translations/ru-RU/content/actions/hosting-your-own-runners/about-self-hosted-runners.md @@ -120,6 +120,7 @@ You must ensure that the machine has the appropriate network access to communica github.com api.github.com *.actions.githubusercontent.com +github-releases.githubusercontent.com codeload.github.com ``` diff --git a/translations/zh-CN/content/actions/hosting-your-own-runners/about-self-hosted-runners.md b/translations/zh-CN/content/actions/hosting-your-own-runners/about-self-hosted-runners.md index ffdf91334fad..dd15d2a59f3a 100644 --- a/translations/zh-CN/content/actions/hosting-your-own-runners/about-self-hosted-runners.md +++ b/translations/zh-CN/content/actions/hosting-your-own-runners/about-self-hosted-runners.md @@ -120,6 +120,7 @@ The following processor architectures are supported for the self-hosted runner a github.com api.github.com *.actions.githubusercontent.com +github-releases.githubusercontent.com codeload.github.com ```